diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-14 10:50:11 -0400 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-16 07:44:19 -0400 |
| commit | ff41c41943de489ccb12d064faae1e32265f7d56 (patch) | |
| tree | 655c01ff8ca0b51992d712d1145ac038ea1d4be1 /Documentation/kernel-doc-nano-HOWTO.txt | |
| parent | cb43fb5775dffb36416067be87327966200ee3b6 (diff) | |
docs: update old references for DocBook from the documentation
DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.
Acked-by: SeongJae Park <sj38.park@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/kernel-doc-nano-HOWTO.txt')
| -rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 65 |
1 files changed, 11 insertions, 54 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index 104740ea0041..c23e2c5ab80d 100644 --- a/Documentation/kernel-doc-nano-HOWTO.txt +++ b/Documentation/kernel-doc-nano-HOWTO.txt | |||
| @@ -17,8 +17,8 @@ The format for this documentation is called the kernel-doc format. | |||
| 17 | It is documented in this Documentation/kernel-doc-nano-HOWTO.txt file. | 17 | It is documented in this Documentation/kernel-doc-nano-HOWTO.txt file. |
| 18 | 18 | ||
| 19 | This style embeds the documentation within the source files, using | 19 | This style embeds the documentation within the source files, using |
| 20 | a few simple conventions. The scripts/kernel-doc perl script, some | 20 | a few simple conventions. The scripts/kernel-doc perl script, the |
| 21 | SGML templates in Documentation/DocBook, and other tools understand | 21 | Documentation/sphinx/kerneldoc.py Sphinx extension and other tools understand |
| 22 | these conventions, and are used to extract this embedded documentation | 22 | these conventions, and are used to extract this embedded documentation |
| 23 | into various documents. | 23 | into various documents. |
| 24 | 24 | ||
| @@ -122,15 +122,9 @@ are: | |||
| 122 | - scripts/kernel-doc | 122 | - scripts/kernel-doc |
| 123 | 123 | ||
| 124 | This is a perl script that hunts for the block comments and can mark | 124 | This is a perl script that hunts for the block comments and can mark |
| 125 | them up directly into DocBook, man, text, and HTML. (No, not | 125 | them up directly into DocBook, ReST, man, text, and HTML. (No, not |
| 126 | texinfo.) | 126 | texinfo.) |
| 127 | 127 | ||
| 128 | - Documentation/DocBook/*.tmpl | ||
| 129 | |||
| 130 | These are SGML template files, which are normal SGML files with | ||
| 131 | special place-holders for where the extracted documentation should | ||
| 132 | go. | ||
| 133 | |||
| 134 | - scripts/docproc.c | 128 | - scripts/docproc.c |
| 135 | 129 | ||
| 136 | This is a program for converting SGML template files into SGML | 130 | This is a program for converting SGML template files into SGML |
| @@ -145,25 +139,18 @@ are: | |||
| 145 | 139 | ||
| 146 | - Makefile | 140 | - Makefile |
| 147 | 141 | ||
| 148 | The targets 'xmldocs', 'psdocs', 'pdfdocs', and 'htmldocs' are used | 142 | The targets 'xmldocs', 'latexdocs', 'pdfdocs', 'epubdocs'and 'htmldocs' |
| 149 | to build XML DocBook files, PostScript files, PDF files, and html files | 143 | are used to build XML DocBook files, LaTeX files, PDF files, |
| 150 | in Documentation/DocBook. The older target 'sgmldocs' is equivalent | 144 | ePub files and html files in Documentation/. |
| 151 | to 'xmldocs'. | ||
| 152 | |||
| 153 | - Documentation/DocBook/Makefile | ||
| 154 | |||
| 155 | This is where C files are associated with SGML templates. | ||
| 156 | |||
| 157 | 145 | ||
| 158 | How to extract the documentation | 146 | How to extract the documentation |
| 159 | -------------------------------- | 147 | -------------------------------- |
| 160 | 148 | ||
| 161 | If you just want to read the ready-made books on the various | 149 | If you just want to read the ready-made books on the various |
| 162 | subsystems (see Documentation/DocBook/*.tmpl), just type 'make | 150 | subsystems, just type 'make epubdocs', or 'make pdfdocs', or 'make htmldocs', |
| 163 | psdocs', or 'make pdfdocs', or 'make htmldocs', depending on your | 151 | depending on your preference. If you would rather read a different format, |
| 164 | preference. If you would rather read a different format, you can type | 152 | you can type 'make xmldocs' and then use DocBook tools to convert |
| 165 | 'make xmldocs' and then use DocBook tools to convert | 153 | Documentation/output/*.xml to a format of your choice (for example, |
| 166 | Documentation/DocBook/*.xml to a format of your choice (for example, | ||
| 167 | 'db2html ...' if 'make htmldocs' was not defined). | 154 | 'db2html ...' if 'make htmldocs' was not defined). |
| 168 | 155 | ||
| 169 | If you want to see man pages instead, you can do this: | 156 | If you want to see man pages instead, you can do this: |
| @@ -329,37 +316,7 @@ This is done by using a DOC: section keyword with a section title. E.g.: | |||
| 329 | * hardware, software, or its subject(s). | 316 | * hardware, software, or its subject(s). |
| 330 | */ | 317 | */ |
| 331 | 318 | ||
| 332 | DOC: sections are used in SGML templates files as indicated below. | 319 | DOC: sections are used in ReST files. |
| 333 | |||
| 334 | |||
| 335 | How to make new SGML template files | ||
| 336 | ----------------------------------- | ||
| 337 | |||
| 338 | SGML template files (*.tmpl) are like normal SGML files, except that | ||
| 339 | they can contain escape sequences where extracted documentation should | ||
| 340 | be inserted. | ||
| 341 | |||
| 342 | !E<filename> is replaced by the documentation, in <filename>, for | ||
| 343 | functions that are exported using EXPORT_SYMBOL: the function list is | ||
| 344 | collected from files listed in Documentation/DocBook/Makefile. | ||
| 345 | |||
| 346 | !I<filename> is replaced by the documentation for functions that are | ||
| 347 | _not_ exported using EXPORT_SYMBOL. | ||
| 348 | |||
| 349 | !D<filename> is used to name additional files to search for functions | ||
| 350 | exported using EXPORT_SYMBOL. | ||
| 351 | |||
| 352 | !F<filename> <function [functions...]> is replaced by the | ||
| 353 | documentation, in <filename>, for the functions listed. | ||
| 354 | |||
| 355 | !P<filename> <section title> is replaced by the contents of the DOC: | ||
| 356 | section titled <section title> from <filename>. | ||
| 357 | Spaces are allowed in <section title>; do not quote the <section title>. | ||
| 358 | |||
| 359 | !C<filename> is replaced by nothing, but makes the tools check that | ||
| 360 | all DOC: sections and documented functions, symbols, etc. are used. | ||
| 361 | This makes sense to use when you use !F/!P only and want to verify | ||
| 362 | that all documentation is included. | ||
| 363 | 320 | ||
| 364 | Tim. | 321 | Tim. |
| 365 | */ <twaugh@redhat.com> | 322 | */ <twaugh@redhat.com> |
