Skip to content

Commit 8ba3c49

Browse files
committed
Input format: note about include! macros
1 parent e364b6c commit 8ba3c49

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/input-format.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,16 @@ fn main() {
3737
As an exception, if the `#!` characters are followed (ignoring intervening [comments] or [whitespace]) by a `[` token, nothing is removed.
3838
This prevents an [inner attribute] at the start of a source file being removed.
3939

40+
> **Note**: The standard library [`include!`] macro applies byte order mark removal, CRLF normalization, and shebang removal to the file it reads. The [`include_str!`] and [`include_bytes!`] macros do not.
41+
4042
## Tokenization
4143

4244
The resulting sequence of characters is then converted into tokens as described in the remainder of this chapter.
4345

46+
47+
[`include!`]: ../std/macro.include.md
48+
[`include_bytes!`]: ../std/macro.include_bytes.md
49+
[`include_str!`]: ../std/macro.include_str.md
4450
[inner attribute]: attributes.md
4551
[BYTE ORDER MARK]: https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8
4652
[comments]: comments.md

0 commit comments

Comments
 (0)