aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/doc-guide
AgeCommit message (Expand)AuthorFilesLines
2024-03-03docs: drop the version constraints for sphinx and dependenciesLukas Bulwahn1-5/+6
2024-02-05Documentation: multiple .rst files: Fix grammar and more consistent formattingThorsten Blum1-4/+3
2024-01-30doc-guide: kernel-doc: tell about object-like macrosRandy Dunlap1-0/+45
2024-01-30docs: add blurb about target audience to maintainer-profileVegard Nossum1-0/+7
2023-12-15docs: Raise the minimum Sphinx requirement to 2.4.4Jonathan Corbet1-1/+1
2023-11-17docs: automarkup: linkify git revsVegard Nossum1-0/+9
2023-10-22docs: doc-guide: mention 'make refcheckdocs'Vegard Nossum1-0/+4
2023-07-14Documentation: doc-guide: use '%' constant indicator in Return: examplesRandy Dunlap1-5/+5
2023-06-09docs/doc-guide: Clarify how to write tablesJoe Stringer1-1/+10
2022-10-18Merge branch 'alabaster-rb' into docs-mwJonathan Corbet1-11/+5
2022-10-13docs: update sphinx.rst to reflect the default theme changeJonathan Corbet1-11/+5
2022-10-03Merge tag 'rust-v6.1-rc1' of https://github.com/Rust-for-Linux/linuxLinus Torvalds1-0/+3
2022-09-29docs/doc-guide: Add documentation on SPHINX_IMGMATHAkira Yokosawa1-4/+53
2022-09-28docs: add Rust documentationMiguel Ojeda1-0/+3
2022-06-30docs/doc-guide: Mention make variable SPHINXDIRSAkira Yokosawa1-0/+7
2022-06-27docs/doc-guide: Put meta title for kernel-doc HTML pageAkira Yokosawa1-0/+2
2022-06-27docs/doc-guide: Add footnote on Inkscape for better images in PDF documentsAkira Yokosawa1-1/+6
2022-05-09Documentation/process: use scripts/get_maintainer.pl on patchesKrzysztof Kozlowski1-2/+3
2022-04-05Documentation: sphinx: replace "Introduction" chapter heading with page titleBagas Sanjaya1-2/+3
2022-04-05Documentation: kernel-doc: Promote two chapter headings to page titleBagas Sanjaya1-0/+2
2022-01-07docs: discourage use of list tablesJonathan Corbet1-6/+5
2021-12-16docs: address some text issues with css/theme supportMauro Carvalho Chehab1-1/+1
2021-12-10docs: allow to pass extra DOCS_CSS themes via makeMauro Carvalho Chehab1-0/+3
2021-12-10docs: allow selecting a Sphinx themeMauro Carvalho Chehab1-0/+8
2021-11-15docs: Update Sphinx requirementsAkira Yokosawa1-13/+9
2021-06-17docs: doc-guide: avoid using ReST :doc:`foo` markupMauro Carvalho Chehab1-4/+4
2021-02-04docs: Document cross-referencing using relative pathNícolas F. R. A. Prado1-10/+20
2020-12-31Documentation: doc-guide: fixes to sphinx.rstRandy Dunlap1-16/+16
2020-12-08kernel-doc: Fix example in Nested structs/unionsBen Widawsky1-3/+3
2020-12-03Documentation: fix typos found in process, dev-tools, and doc-guide subdirect...Andrew Klychkov1-1/+1
2020-10-15docs: kerneldoc.py: add support for kerneldoc -nosymbolMauro Carvalho Chehab1-0/+8
2020-09-16docs: Document cross-referencing between documentation pagesNícolas F. R. A. Prado1-0/+17
2020-09-03kernel-doc: Update "cross-referencing from rST" section to use automarkupNícolas F. R. A. Prado1-16/+17
2020-06-10Merge tag 'docs-5.8-2' of git://git.lwn.net/linuxLinus Torvalds1-1/+1
2020-06-08Replace HTTP links with HTTPS ones: documentationAlexander A. Klimov1-1/+1
2020-06-03Merge tag 'media/v5.8-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mch...Linus Torvalds1-1/+1
2020-04-20docs: fix broken references for ReST files that moved aroundMauro Carvalho Chehab1-1/+1
2020-04-14media: docs: move uAPI book to userspace-api/mediaMauro Carvalho Chehab1-1/+1
2020-02-05Documentation: build warnings related to missing blank lines after explicit m...Sameer Rahmani2-0/+2
2020-01-24Add a maintainer entry profile for documentationJonathan Corbet2-0/+45
2020-01-24Add a document on how to contribute to the documentationJonathan Corbet2-0/+295
2019-11-07kernel-doc: rename the kernel-doc directive 'functions' to 'identifiers'Changbin Du1-13/+16
2019-07-17docs: remove extra conf.py filesMauro Carvalho Chehab1-10/+0
2019-06-28Doc : doc-guide : Fix a typoSheriff Esseson1-1/+1
2019-06-26docs: Note that :c:func: should no longer be usedJonathan Corbet1-5/+8
2019-06-14sphinx.rst: Add note about code snippets embedded in the textAndré Almeida1-1/+1
2019-05-30docs: requirements.txt: recommend Sphinx 1.7.9Mauro Carvalho Chehab1-9/+8
2019-04-19docs: doc-guide: remove the extension from .rst filesMauro Carvalho Chehab1-3/+3
2019-02-17docs: kernel-doc: typo "if ... if" -> "if ... is"Frank Rowand1-1/+1
2019-02-01docs: kernel-doc: typo "documentaion"Frank Rowand1-1/+1
2019-02-01docs: kernel-doc: update commands to generate man pageFrank Rowand1-1/+14
2019-01-14docs-rst: doc-guide: Minor grammar fixesJoel Nider1-6/+6
2018-12-06doc:process: add links where missingFederico Vaga1-0/+2
2018-11-07doc-guide:kernel-doc.rst: Reference to foobarJoris Gutjahr1-1/+1
2018-06-30Documentation/sphinx: allow "functions" with no parametersMike Rapoport1-2/+7
2018-06-26doc:sphinx: fix parse-header descriptionFederico Vaga1-1/+1
2018-06-26doc:doc-guide: fix a typo and an errorFederico Vaga2-2/+2
2018-05-04MAINTAINERS & files: Canonize the e-mails I use at filesMauro Carvalho Chehab1-2/+2
2018-02-23doc-guide: kernel-doc: add comment about formatting verificationMike Rapoport1-0/+11
2018-02-18doc-guide: kernel-doc: add examples about nested union/structsMauro Carvalho Chehab1-2/+11
2018-02-18doc-guide: kernel-doc: move in-line section to be after nested structMauro Carvalho Chehab1-28/+28
2018-02-18doc-guide: kernel-doc: fix example for inlined commentsMauro Carvalho Chehab1-1/+1
2018-02-18doc-guide: kernel-doc: fix example for nested_foobar structMauro Carvalho Chehab1-0/+4
2018-02-13Restructure kernel-doc.rstMatthew Wilcox1-259/+217
2018-02-13Fix whitespace in exampleMatthew Wilcox1-1/+1
2018-02-13Add scripts/split-man.plMatthew Wilcox1-28/+2
2018-02-13Minor fixes to kernel-doc.rstMatthew Wilcox1-8/+8
2018-02-13Add documentation for Context sectionMatthew Wilcox1-0/+25
2017-12-21scripts: kernel-doc: parse next structs/unionsMauro Carvalho Chehab1-0/+46
2017-12-21docs: kernel-doc.rst: add documentation about man pagesMauro Carvalho Chehab1-0/+34
2017-12-21docs: kernel-doc.rst: improve typedef documentationMauro Carvalho Chehab1-10/+22
2017-12-21docs: kernel-doc.rst: improve structs chapterMauro Carvalho Chehab1-24/+24
2017-12-21docs: kernel-doc.rst: improve function documentation sectionMauro Carvalho Chehab1-39/+61
2017-12-21docs: kernel-doc.rst: improve private members descriptionMauro Carvalho Chehab1-26/+30
2017-12-21docs: kernel-doc.rst: better describe kernel-doc argumentsMauro Carvalho Chehab1-3/+41
2017-10-19Documentation: fix ref to sphinx/kerneldoc.pyTom Saeger1-1/+1
2017-08-26sphinx.rst: Allow Sphinx version 1.6 at the docsMauro Carvalho Chehab1-3/+1
2017-07-23sphinx.rst: document scripts/sphinx-pre-install scriptMauro Carvalho Chehab1-4/+44
2017-07-17sphinx.rst: better organize the documentation about PDF buildMauro Carvalho Chehab1-8/+13
2017-07-17sphinx.rst: describe the install requirements for kfigureMauro Carvalho Chehab1-0/+13
2017-07-17sphinx.rst: fix unknown referenceMauro Carvalho Chehab1-1/+1
2017-07-17sphinx.rst: explain the usage of virtual environmentMauro Carvalho Chehab1-0/+32
2017-07-17docs-rst: move Sphinx install instructions to sphinx.rstMauro Carvalho Chehab1-0/+17
2017-05-16kernel-doc: describe the ``literal`` syntaxMauro Carvalho Chehab1-0/+10
2017-05-16docs: update old references for DocBook from the documentationMauro Carvalho Chehab2-6/+0
2017-05-16docs: remove DocBook from the building systemMauro Carvalho Chehab1-90/+0
2017-03-09docs-rst: automatically convert Graphviz and SVG imagesMarkus Heiser3-2/+109
2017-03-09doc: Explain light-handed markup preference a bit betterDaniel Vetter1-1/+16
2016-11-30docs-rst: parse-headers.pl: cleanup the documentationMauro Carvalho Chehab1-19/+3
2016-11-19Merge branch 'mauro-doc' into docs-nextJonathan Corbet6-0/+915
2016-11-19parse-headers.rst: add an introduction to the man pageMauro Carvalho Chehab1-2/+24
2016-11-19parse-headers.pl: add documentation for this scriptMauro Carvalho Chehab2-0/+187
2016-11-19docs-rst: doc-guide: split the kernel-documentation.rst contentsMauro Carvalho Chehab5-0/+701