bazelbuild/bazel

Documentation issue: C++ Use Cases snippet is unix only

Open

#14,520 opened on Jan 6, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3area-Windowshelp wantedteam-Documentationteam-Rules-CPPtype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

Documentation URL: https://docs.bazel.build/versions/4.2.2/cpp-use-cases.html

Could you ,at least, add a note that your sample are unix (linux ?) only ? e.g.

https://github.com/bazelbuild/bazel/blob/b93543c78e1bfab0479b52fcbd1f14197083a44f/site/docs/cpp-use-cases.md#L150-L154

-I is not supported by msvc aka non GNU-like compilers nor the -pthread option...

I can understand you don't want to bloat the tutorial with conditions and use of select but...

Contributor guide

Research direction
Add a note to the documentation page indicating that the sample commands are Unix only and not compatible with MSVC or non GNU compilers.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90