llvm-project/flang/docs/Directives.md

<!--===- docs/Directives.md 
  
   Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   See https://llvm.org/LICENSE.txt for license information.
   SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  
-->

# Compiler directives supported by Flang

A list of non-standard directives supported by Flang

* `!dir$ fixed` and `!dir$ free` select Fortran source forms.  Their effect
  persists to the end of the current source file.
* `!dir$ ignore_tkr (tkr) var-list` omits checks on type, kind, and/or rank.
Revert D86875 "[Flang][NFC] Remove license comments from files in docs/ folder." This reverts commit f787c9a90c69f, this was causing some build issues. 2020-09-11 01:34:37 +08:00			`<!--===- docs/Directives.md`

			`Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.`
			`See https://llvm.org/LICENSE.txt for license information.`
			`SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception`

			`-->`

[flang] Add new documentation main page Add a new index page to be the Flang documentation mainpage instead of Overview.md, which jumps straight into the compiler Design. The index file needs to be in .rst format to use the toctree directive to create table of contents. Also use the sphinx_markdown_tables extension to generate html tables form markdown. A number of additional style changes to the existing docs were needed to make this work well: * Convert all headings to the # style, which works better with toctree's titlesonly option. Ensure that there is only one top-level heading per document. * Add a title to documents that don't have one for rendering on the index. * Convert the grammar docs from .txt to .md. for better rendering * Fixed broken link to a section in another document - sphinx does not seem to support anchor links in markdown files. Depends on D87226 Reviewed By: sameeranjoshi Differential Revision: https://reviews.llvm.org/D87242 2020-09-11 21:17:19 +08:00			`# Compiler directives supported by Flang`

			`A list of non-standard directives supported by Flang`
[flang] Clean out obsolete parsing code. Handle !cdir$ fixed and free in parser. Work on scanning compiler directive lines. Fix glitch in earlier change to parse-state.h. Add ClassifyLine(), simplify some token sequence data lifetimes and interfaces. Handle continued directives. Obey !DIR$ FIXED and FREE in prescanner. Some refactoring of TokenSequence API, then support initial directives (FIXED, FREE, IGNORE_TKR). Fix !DIR$ IGNORE_TKR syntax, manual was wrong. Debugging directive scanning & parsing. Profiling-directed speed-up - do not map cooked source locations to Provenance until a Message is emitted. Turn some non-nullable pointers into references. Debugging. Handle !DIR$ IVDEP too, it is in a test. Accept directives in the execution part. Original-commit: flang-compiler/f18@fb2ff367ec0609b7307771f927f22fd7bab5e180 Reviewed-on: https://github.com/flang-compiler/f18/pull/34 Tree-same-pre-rewrite: false 2018-03-24 06:14:52 +08:00
			* `!dir$ fixed` and `!dir$ free` select Fortran source forms. Their effect
			`persists to the end of the current source file.`
			* `!dir$ ignore_tkr (tkr) var-list` omits checks on type, kind, and/or rank.