Skip to content

Commit

Permalink
clean up wording
Browse files Browse the repository at this point in the history
  • Loading branch information
apenn-msft authored Oct 11, 2023
1 parent e10f783 commit c8b8d9e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CppCoreGuidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -19636,12 +19636,12 @@ A test should identify whether headers referenced via `""` could be referenced w

##### Reason

The [standard](http://eel.is/c++draft/cpp.include) does not specify how compilers locate headers from a unique identifier in a `#include` directive, nor does it specify what constitutes uniqueness for an identifier. For example, whether the implementation considers the identifiers to be case-sensitive, or whether the identifiers are file system paths to a header file, and if so, how a hierarchical file system path is delimited.
The [standard](http://eel.is/c++draft/cpp.include) does not specify how compilers uniquely locate headers from an identifier in an `#include` directive, nor does it specify what constitutes uniqueness. For example, whether the implementation considers the identifiers to be case-sensitive, or whether the identifiers are file system paths to a header file, and if so, how a hierarchical file system path is delimited.

To maximize the portability of `#include` directives across compilers, guidance is to:

* use case-sensitivity for the header identifier, matching how the header is defined by the standard, specification, implementation, header file, etc.
* when the header identifier is a hierarchical file system path, use forward-slash `/` to delimit path components as this is the most widely-accepted, portable path-delimiting character.
* use case-sensitivity for the header identifier, matching how the header is defined by the standard, specification, implementation, or file that provides the header.
* when the header identifier is a hierarchical file path, use forward-slash `/` to delimit path components as this is the most widely-accepted path-delimiting character.

##### Example

Expand Down

0 comments on commit c8b8d9e

Please sign in to comment.