Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

+21 -146
+1 -1
Documentation/PCI/MSI-HOWTO.txt
··· 186 186 a different interrupt, the driver will deadlock trying to recursively 187 187 acquire the spinlock. Such deadlocks can be avoided by using 188 188 spin_lock_irqsave() or spin_lock_irq() which disable local interrupts 189 - and acquire the lock (see Documentation/DocBook/kernel-locking). 189 + and acquire the lock (see Documentation/kernel-hacking/locking.rst). 190 190 191 191 4.5 How to tell whether MSI/MSI-X is enabled on a device 192 192
-6
Documentation/admin-guide/README.rst
··· 55 55 contains information about the problems, which may result by upgrading 56 56 your kernel. 57 57 58 - - The Documentation/DocBook/ subdirectory contains several guides for 59 - kernel developers and users. These guides can be rendered in a 60 - number of formats: PostScript (.ps), PDF, HTML, & man-pages, among others. 61 - After installation, ``make psdocs``, ``make pdfdocs``, ``make htmldocs``, 62 - or ``make mandocs`` will render the documentation in the requested format. 63 - 64 58 Installing the kernel source 65 59 ---------------------------- 66 60
-1
Documentation/doc-guide/index.rst
··· 10 10 sphinx.rst 11 11 kernel-doc.rst 12 12 parse-headers.rst 13 - docbook.rst 14 13 15 14 .. only:: subproject and html 16 15
-5
Documentation/doc-guide/sphinx.rst
··· 15 15 kernel-doc comments have some special structure and formatting, but beyond that 16 16 they are also treated as reStructuredText. 17 17 18 - There is also the deprecated DocBook toolchain to generate documentation from 19 - DocBook XML template files under ``Documentation/DocBook``. The DocBook files 20 - are to be converted to reStructuredText, and the toolchain is slated to be 21 - removed. 22 - 23 18 Finally, there are thousands of plain text documentation files scattered around 24 19 ``Documentation``. Some of these will likely be converted to reStructuredText 25 20 over time, but the bulk of them will remain in plain text.
+2 -2
Documentation/fb/api.txt
··· 289 289 FOURCC definitions are located in the linux/videodev2.h header. However, and 290 290 despite starting with the V4L2_PIX_FMT_prefix, they are not restricted to V4L2 291 291 and don't require usage of the V4L2 subsystem. FOURCC documentation is 292 - available in Documentation/DocBook/v4l/pixfmt.xml. 292 + available in Documentation/media/uapi/v4l/pixfmt.rst. 293 293 294 294 To select a format, applications set the grayscale field to the desired FOURCC. 295 295 For YUV formats, they should also select the appropriate colorspace by setting 296 296 the colorspace field to one of the colorspaces listed in linux/videodev2.h and 297 - documented in Documentation/DocBook/v4l/colorspaces.xml. 297 + documented in Documentation/media/uapi/v4l/colorspaces.rst. 298 298 299 299 The red, green, blue and transp fields are not used with the FOURCC-based API. 300 300 For forward compatibility reasons applications must zero those fields, and
+1 -1
Documentation/gpu/todo.rst
··· 228 228 task would be to clean up interfaces like moving functions around between 229 229 files to better group them and improving the interfaces like dropping return 230 230 values for functions that never fail. Then write kerneldoc for all exported 231 - functions and an overview section and integrate it all into the drm DocBook. 231 + functions and an overview section and integrate it all into the drm book. 232 232 233 233 See https://dri.freedesktop.org/docs/drm/ for what's there already. 234 234
+11 -54
Documentation/kernel-doc-nano-HOWTO.txt
··· 17 17 It is documented in this Documentation/kernel-doc-nano-HOWTO.txt file. 18 18 19 19 This style embeds the documentation within the source files, using 20 - a few simple conventions. The scripts/kernel-doc perl script, some 21 - SGML templates in Documentation/DocBook, and other tools understand 20 + a few simple conventions. The scripts/kernel-doc perl script, the 21 + Documentation/sphinx/kerneldoc.py Sphinx extension and other tools understand 22 22 these conventions, and are used to extract this embedded documentation 23 23 into various documents. 24 24 ··· 122 122 - scripts/kernel-doc 123 123 124 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 126 texinfo.) 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 127 134 128 - scripts/docproc.c 135 129 ··· 139 145 140 146 - Makefile 141 147 142 - The targets 'xmldocs', 'psdocs', 'pdfdocs', and 'htmldocs' are used 143 - to build XML DocBook files, PostScript files, PDF files, and html files 144 - in Documentation/DocBook. The older target 'sgmldocs' is equivalent 145 - to 'xmldocs'. 146 - 147 - - Documentation/DocBook/Makefile 148 - 149 - This is where C files are associated with SGML templates. 150 - 148 + The targets 'xmldocs', 'latexdocs', 'pdfdocs', 'epubdocs'and 'htmldocs' 149 + are used to build XML DocBook files, LaTeX files, PDF files, 150 + ePub files and html files in Documentation/. 151 151 152 152 How to extract the documentation 153 153 -------------------------------- 154 154 155 155 If you just want to read the ready-made books on the various 156 - subsystems (see Documentation/DocBook/*.tmpl), just type 'make 157 - psdocs', or 'make pdfdocs', or 'make htmldocs', depending on your 158 - preference. If you would rather read a different format, you can type 159 - 'make xmldocs' and then use DocBook tools to convert 160 - Documentation/DocBook/*.xml to a format of your choice (for example, 156 + subsystems, just type 'make epubdocs', or 'make pdfdocs', or 'make htmldocs', 157 + depending on your preference. If you would rather read a different format, 158 + you can type 'make xmldocs' and then use DocBook tools to convert 159 + Documentation/output/*.xml to a format of your choice (for example, 161 160 'db2html ...' if 'make htmldocs' was not defined). 162 161 163 162 If you want to see man pages instead, you can do this: ··· 316 329 * hardware, software, or its subject(s). 317 330 */ 318 331 319 - DOC: sections are used in SGML templates files as indicated below. 320 - 321 - 322 - How to make new SGML template files 323 - ----------------------------------- 324 - 325 - SGML template files (*.tmpl) are like normal SGML files, except that 326 - they can contain escape sequences where extracted documentation should 327 - be inserted. 328 - 329 - !E<filename> is replaced by the documentation, in <filename>, for 330 - functions that are exported using EXPORT_SYMBOL: the function list is 331 - collected from files listed in Documentation/DocBook/Makefile. 332 - 333 - !I<filename> is replaced by the documentation for functions that are 334 - _not_ exported using EXPORT_SYMBOL. 335 - 336 - !D<filename> is used to name additional files to search for functions 337 - exported using EXPORT_SYMBOL. 338 - 339 - !F<filename> <function [functions...]> is replaced by the 340 - documentation, in <filename>, for the functions listed. 341 - 342 - !P<filename> <section title> is replaced by the contents of the DOC: 343 - section titled <section title> from <filename>. 344 - Spaces are allowed in <section title>; do not quote the <section title>. 345 - 346 - !C<filename> is replaced by nothing, but makes the tools check that 347 - all DOC: sections and documented functions, symbols, etc. are used. 348 - This makes sense to use when you use !F/!P only and want to verify 349 - that all documentation is included. 332 + DOC: sections are used in ReST files. 350 333 351 334 Tim. 352 335 */ <twaugh@redhat.com>
+5 -21
Documentation/process/changes.rst
··· 116 116 117 117 Linux documentation for functions is transitioning to inline 118 118 documentation via specially-formatted comments near their 119 - definitions in the source. These comments can be combined with the 120 - SGML templates in the Documentation/DocBook directory to make DocBook 121 - files, which can then be converted by DocBook stylesheets to PostScript, 122 - HTML, PDF files, and several other formats. In order to convert from 123 - DocBook format to a format of your choice, you'll need to install Jade as 124 - well as the desired DocBook stylesheets. 119 + definitions in the source. These comments can be combined with ReST 120 + files the Documentation/ directory to make enriched documentation, which can 121 + then be converted to PostScript, HTML, LaTex, ePUB and PDF files. 122 + In order to convert from ReST format to a format of your choice, you'll need 123 + Sphinx. 125 124 126 125 Util-linux 127 126 ---------- ··· 322 323 functionalities required for ``XeLaTex`` to work. For PDF output you'll also 323 324 need ``convert(1)`` from ImageMagick (https://www.imagemagick.org). 324 325 325 - Other tools 326 - ----------- 327 - 328 - In order to produce documentation from DocBook, you'll also need ``xmlto``. 329 - Please notice, however, that we're currently migrating all documents to use 330 - ``Sphinx``. 331 326 332 327 Getting updated software 333 328 ======================== ··· 402 409 403 410 - <http://sourceforge.net/projects/linuxquota/> 404 411 405 - DocBook Stylesheets 406 - ------------------- 407 - 408 - - <http://sourceforge.net/projects/docbook/files/docbook-dsssl/> 409 - 410 - XMLTO XSLT Frontend 411 - ------------------- 412 - 413 - - <http://cyberelk.net/tim/xmlto/> 414 412 415 413 Intel P6 microcode 416 414 ------------------
-8
Documentation/process/howto.rst
··· 180 180 make latexdocs 181 181 make epubdocs 182 182 183 - Currently, there are some documents written on DocBook that are in 184 - the process of conversion to ReST. Such documents will be created in the 185 - Documentation/DocBook/ directory and can be generated also as 186 - Postscript or man pages by running:: 187 - 188 - make psdocs 189 - make mandocs 190 - 191 183 Becoming A Kernel Developer 192 184 --------------------------- 193 185
+1 -33
Documentation/process/kernel-docs.rst
··· 40 40 Docs at the Linux Kernel tree 41 41 ----------------------------- 42 42 43 - The DocBook books should be built with ``make {htmldocs | psdocs | pdfdocs}``. 44 43 The Sphinx books should be built with ``make {htmldocs | pdfdocs | epubdocs}``. 45 44 46 45 * Name: **linux/Documentation** 47 46 48 47 :Author: Many. 49 48 :Location: Documentation/ 50 - :Keywords: text files, Sphinx, DocBook. 49 + :Keywords: text files, Sphinx. 51 50 :Description: Documentation that comes with the kernel sources, 52 51 inside the Documentation directory. Some pages from this document 53 52 (including this document itself) have been moved there, and might 54 53 be more up to date than the web version. 55 - 56 - * Title: **The Kernel Hacking HOWTO** 57 - 58 - :Author: Various Talented People, and Rusty. 59 - :Location: Documentation/DocBook/kernel-hacking.tmpl 60 - :Keywords: HOWTO, kernel contexts, deadlock, locking, modules, 61 - symbols, return conventions. 62 - :Description: From the Introduction: "Please understand that I 63 - never wanted to write this document, being grossly underqualified, 64 - but I always wanted to read it, and this was the only way. I 65 - simply explain some best practices, and give reading entry-points 66 - into the kernel sources. I avoid implementation details: that's 67 - what the code is for, and I ignore whole tracts of useful 68 - routines. This document assumes familiarity with C, and an 69 - understanding of what the kernel is, and how it is used. It was 70 - originally written for the 2.3 kernels, but nearly all of it 71 - applies to 2.2 too; 2.0 is slightly different". 72 - 73 - * Title: **Linux Kernel Locking HOWTO** 74 - 75 - :Author: Various Talented People, and Rusty. 76 - :Location: Documentation/DocBook/kernel-locking.tmpl 77 - :Keywords: locks, locking, spinlock, semaphore, atomic, race 78 - condition, bottom halves, tasklets, softirqs. 79 - :Description: The title says it all: document describing the 80 - locking system in the Linux Kernel either in uniprocessor or SMP 81 - systems. 82 - :Notes: "It was originally written for the later (>2.3.47) 2.3 83 - kernels, but most of it applies to 2.2 too; 2.0 is slightly 84 - different". Freely redistributable under the conditions of the GNU 85 - General Public License. 86 54 87 55 On-line docs 88 56 ------------
-7
Documentation/translations/ja_JP/howto.rst
··· 197 197 make latexdocs 198 198 make epubdocs 199 199 200 - 現在、幾つかの DocBook形式で書かれたドキュメントは ReST形式に転換中で 201 - す。それらのドキュメントはDocumentation/DocBook ディレクトリに生成され、 202 - Postscript または man ページの形式を生成するには以下のようにします - :: 203 - 204 - make psdocs 205 - make mandocs 206 - 207 200 カーネル開発者になるには 208 201 ------------------------ 209 202
-7
Documentation/translations/ko_KR/howto.rst
··· 191 191 make latexdocs 192 192 make epubdocs 193 193 194 - 현재, ReST 로의 변환이 진행중인, DocBook 으로 쓰인 문서들이 존재한다. 그런 195 - 문서들은 Documentation/DocBook/ 디렉토리 안에 생성될 것이고 다음 커맨드를 통해 196 - Postscript 나 man page 로도 만들어질 수 있다:: 197 - 198 - make psdocs 199 - make mandocs 200 - 201 194 커널 개발자가 되는 것 202 195 --------------------- 203 196