summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'docs-5.3' of git://git.lwn.net/linuxLinus Torvalds2019-07-09416-8581/+12159
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull Documentation updates from Jonathan Corbet: "It's been a relatively busy cycle for docs: - A fair pile of RST conversions, many from Mauro. These create more than the usual number of simple but annoying merge conflicts with other trees, unfortunately. He has a lot more of these waiting on the wings that, I think, will go to you directly later on. - A new document on how to use merges and rebases in kernel repos, and one on Spectre vulnerabilities. - Various improvements to the build system, including automatic markup of function() references because some people, for reasons I will never understand, were of the opinion that :c:func:``function()`` is unattractive and not fun to type. - We now recommend using sphinx 1.7, but still support back to 1.4. - Lots of smaller improvements, warning fixes, typo fixes, etc" * tag 'docs-5.3' of git://git.lwn.net/linux: (129 commits) docs: automarkup.py: ignore exceptions when seeking for xrefs docs: Move binderfs to admin-guide Disable Sphinx SmartyPants in HTML output doc: RCU callback locks need only _bh, not necessarily _irq docs: format kernel-parameters -- as code Doc : doc-guide : Fix a typo platform: x86: get rid of a non-existent document Add the RCU docs to the core-api manual Documentation: RCU: Add TOC tree hooks Documentation: RCU: Rename txt files to rst Documentation: RCU: Convert RCU UP systems to reST Documentation: RCU: Convert RCU linked list to reST Documentation: RCU: Convert RCU basic concepts to reST docs: filesystems: Remove uneeded .rst extension on toctables scripts/sphinx-pre-install: fix out-of-tree build docs: zh_CN: submitting-drivers.rst: Remove a duplicated Documentation/ Documentation: PGP: update for newer HW devices Documentation: Add section about CPU vulnerabilities for Spectre Documentation: platform: Delete x86-laptop-drivers.txt docs: Note that :c:func: should no longer be used ...
| * docs: automarkup.py: ignore exceptions when seeking for xrefsMauro Carvalho Chehab2019-07-081-2/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When using the automarkup extension with: make pdfdocs without passing an specific book, the code will raise an exception: File "/devel/v4l/docs/Documentation/sphinx/automarkup.py", line 86, in auto_markup node.parent.replace(node, markup_funcs(name, app, node)) File "/devel/v4l/docs/Documentation/sphinx/automarkup.py", line 59, in markup_funcs 'function', target, pxref, lit_text) File "/devel/v4l/docs/sphinx_2.0/lib/python3.7/site-packages/sphinx/domains/c.py", line 308, in resolve_xref contnode, target) File "/devel/v4l/docs/sphinx_2.0/lib/python3.7/site-packages/sphinx/util/nodes.py", line 450, in make_refnode '#' + targetid) File "/devel/v4l/docs/sphinx_2.0/lib/python3.7/site-packages/sphinx/builders/latex/__init__.py", line 159, in get_relative_uri return self.get_target_uri(to, typ) File "/devel/v4l/docs/sphinx_2.0/lib/python3.7/site-packages/sphinx/builders/latex/__init__.py", line 152, in get_target_uri raise NoUri sphinx.environment.NoUri This happens because not all references will belong to a single PDF/LaTeX document. Better to just ignore those than breaking Sphinx build. Fixes: d74b0d31ddde ("Docs: An initial automarkup extension for sphinx") Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> [jc: Narrowed the "except" and tweaked the comment] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Move binderfs to admin-guideMatthew Wilcox (Oracle)2019-07-083-10/+1
| | | | | | | | | | | | | | | | | | The documentation is more appropriate for the administrator than for the internal kernel API section it is currently in. Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> Acked-by: Christian Brauner <christian@brauner.io> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Disable Sphinx SmartyPants in HTML outputStephen Kitt2019-06-301-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | The handling of dashes in particular results in confusing documentation in a number of instances, since "--" becomes an en-dash. This disables SmartyPants wholesale, losing smart quotes along with smart dashes. With Sphinx 1.6 we could fine-tune the conversion, using the new smartquotes and smartquotes_action settings. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: RCU callback locks need only _bh, not necessarily _irqJiunn Chang2019-06-281-6/+7
| | | | | | | | | | | | | | | | | | | | | | The UP.rst file calls for locks acquired within RCU callback functions to use _irq variants (spin_lock_irqsave() or similar), which does work, but can be overkill. This commit therefore instead calls for _bh variants (spin_lock_bh() or similar), while noting that _irq does work. Signed-off-by: Paul E. McKenney <paulmck@linux.ibm.com> Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: format kernel-parameters -- as codeStephen Kitt2019-06-281-2/+2
| | | | | | | | | | | | | | | | | | | | The current ReStructuredText formatting results in "--", used to indicate the end of the kernel command-line parameters, appearing as an en-dash instead of two hyphens; this patch formats them as code, "``--``", as done elsewhere in the documentation. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Doc : doc-guide : Fix a typoSheriff Esseson2019-06-281-1/+1
| | | | | | | | | | | | | | fix the disjunction by replacing "of" with "or". Signed-off-by: Sheriff Esseson <sheriffesseson@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Merge branch 'automarkup' into docs-nextJonathan Corbet2019-06-285-142/+239
| |\ | | | | | | | | | | | | Bring in (finally) automatic markup of function() so we need not load up our docs with ugly c:func: annotations.
| | * docs: Note that :c:func: should no longer be usedJonathan Corbet2019-06-261-5/+8
| | | | | | | | | | | | | | | | | | | | | | | | Now that we can mark up function() automatically, there is no reason to use :c:func: and every reason to avoid it. Adjust the documentation to reflect that fact. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * kernel-doc: Don't try to mark up function namesJonathan Corbet2019-06-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We now have better automarkup in sphinx itself and, besides, this markup was incorrect and left :c:func: gunk in the processed docs. Sort of discouraging that nobody ever noticed...:) As a first step toward the removal of impenetrable regex magic from kernel-doc it's a tiny one, but you have to start somewhere. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * docs: remove :c:func: annotations from xarray.rstJonathan Corbet2019-06-261-135/+135
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now that the build system automatically marks up function references, we don't have to clutter the source files, so take it out. [Some paragraphs could now benefit from refilling, but that was left out to avoid obscuring the real changes.] Acked-by: Matthew Wilcox <willy@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * Docs: An initial automarkup extension for sphinxJonathan Corbet2019-06-262-1/+95
| | | | | | | | | | | | | | | | | | | | | Rather than fill our text files with :c:func:`function()` syntax, just do the markup via a hook into the sphinx build process. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | platform: x86: get rid of a non-existent documentMauro Carvalho Chehab2019-06-281-3/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Changeset 163ede97a9a2 ("Documentation: platform: Delete x86-laptop-drivers.txt") removed the x86-laptop-drivers.txt file, but forgot to update its Kconfig. Fixes: 163ede97a9a2 ("Documentation: platform: Delete x86-laptop-drivers.txt") Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Add the RCU docs to the core-api manualJonathan Corbet2019-06-271-0/+1
| | | | | | | | | | | | | | | | | | | | | We should really move the RCU directory there as well, but that can wait for another day. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: RCU: Add TOC tree hooksJiunn Chang2019-06-271-0/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add TOC tree hooks for: - rcu - listRCU - UP Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: RCU: Rename txt files to rstJiunn Chang2019-06-273-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Rename the following files to reST: - rcu.txt - listRCU.txt - UP.txt Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: RCU: Convert RCU UP systems to reSTJiunn Chang2019-06-271-14/+23
| | | | | | | | | | | | | | | | | | | | | | | | RCU UP systems reST markup. Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org> Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: RCU: Convert RCU linked list to reSTJiunn Chang2019-06-271-16/+22
| | | | | | | | | | | | | | | | | | | | | RCU linked list reST markup. Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: RCU: Convert RCU basic concepts to reSTJiunn Chang2019-06-271-58/+61
| | | | | | | | | | | | | | | | | | | | | | | | RCU basic concepts reST markup. Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org> Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | docs: filesystems: Remove uneeded .rst extension on toctablesMauro Carvalho Chehab2019-06-272-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | There's no need to use a .rst on Sphinx toc tables. As most of the Documentation don't use, remove the remaing occurrences. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | scripts/sphinx-pre-install: fix out-of-tree buildMike Rapoport2019-06-271-2/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Build of htmldocs fails for out-of-tree builds: $ make V=1 O=~/build/kernel/ htmldocs make -C /home/rppt/build/kernel -f /home/rppt/git/linux-docs/Makefile htmldocs make[1]: Entering directory '/home/rppt/build/kernel' make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=scripts/basic rm -f .tmp_quiet_recordmcount make -f /home/rppt/git/linux-docs/scripts/Makefile.build obj=Documentation htmldocs Can't open Documentation/conf.py at /home/rppt/git/linux-docs/scripts/sphinx-pre-install line 230. /home/rppt/git/linux-docs/Documentation/Makefile:80: recipe for target 'htmldocs' failed make[2]: *** [htmldocs] Error 2 The scripts/sphinx-pre-install is trying to open files in the current directory which is $KBUILD_OUTPUT rather than in $srctree. Fix it. Signed-off-by: Mike Rapoport <rppt@linux.ibm.com> Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | docs: zh_CN: submitting-drivers.rst: Remove a duplicated Documentation/Mauro Carvalho Chehab2019-06-271-1/+1
| | | | | | | | | | | | | | | | | | | | | Somehow, this file ended with Documentation/ twice. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: PGP: update for newer HW devicesKonstantin Ryabitsev2019-06-271-14/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Newer devices like Yubikey 5 and Nitrokey Pro 2 have added support for NISTP's implementation of ECC cryptography, so update the guide accordingly and add a note on when to use nistp256 and when to use ed25519 for generating S keys. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: Add section about CPU vulnerabilities for SpectreTim Chen2019-06-263-0/+700
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add documentation for Spectre vulnerability and the mitigation mechanisms: - Explain the problem and risks - Document the mitigation mechanisms - Document the command line controls - Document the sysfs files Co-developed-by: Andi Kleen <ak@linux.intel.com> Signed-off-by: Andi Kleen <ak@linux.intel.com> Co-developed-by: Tim Chen <tim.c.chen@linux.intel.com> Signed-off-by: Tim Chen <tim.c.chen@linux.intel.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Thomas Gleixner <tglx@linutronix.de> Cc: stable@vger.kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: platform: Delete x86-laptop-drivers.txtPuranjay Mohan2019-06-261-18/+0
| |/ | | | | | | | | | | | | | | | | | | The list of laptops supported by drivers in PDx86 subsystem is quite big and growing. x86-laptop-drivers.txt contains details of very few laptop models. Remove it because it does not serve any purpose. Signed-off-by: Puranjay Mohan <puranjay12@gmail.com> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc-rst: Add missing newline at end of fileGeert Uytterhoeven2019-06-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | "git diff" says: \ No newline at end of file after modifying the file. Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: x86: fix some typosJames Morse2019-06-201-5/+5
| | | | | | | | | | | | | | These are all obvious typos. Signed-off-by: James Morse <james.morse@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: x86: Clarify MBA takes MB as referring to mba_scJames Morse2019-06-201-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | "If the MBA is specified in MB then user can enter the max b/w in MB" is a tautology. How can the user know if the schemata takes a percentage or a MB/s value? This is referring to whether the software controller is interpreting the schemata's value. Make this clear. Signed-off-by: James Morse <james.morse@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: x86: Remove cdpl2 unspported statement and fix capitalisationJames Morse2019-06-201-4/+10
| | | | | | | | | | | | | | | | | | | | | | | | "L2 cache does not support code and data prioritization". This isn't true, elsewhere the document says it can be enabled with the cdpl2 mount option. While we're here, these sample strings have lower-case code/data, which isn't how the kernel exports them. Signed-off-by: James Morse <james.morse@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: x86: Contiguous cbm isn't all X86James Morse2019-06-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | Since commit 4d05bf71f157 ("x86/resctrl: Introduce AMD QOS feature") resctrl has supported non-contiguous cache bit masks. The interface for this is currently try-it-and-see. Update the documentation to say Intel CPUs have this requirement, instead of X86. Cc: Babu Moger <Babu.Moger@amd.com> Signed-off-by: James Morse <james.morse@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/vm: hwpoison.rst: Fix quote formattingValentin Schneider2019-06-201-26/+26
| | | | | | | | | | | | | | | | | | | | | | The asterisks prepended to the quoted text currently get translated to bullet points, which gets increasingly confusing the smaller your screen is (when viewing the sphinx output, that is). Convert the whole quote to a literal block. Signed-off-by: Valentin Schneider <valentin.schneider@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: stop suggesting strlcpyStephen Kitt2019-06-205-12/+12
| | | | | | | | | | | | | | | | | | | | | | | | Since strlcpy is deprecated, the documentation shouldn't suggest using it. This patch fixes the examples to use strscpy instead. It also uses sizeof instead of underlying constants as far as possible, to simplify future changes to the corresponding data structures. Signed-off-by: Stephen Kitt <steve@sk2.org> Acked-by: Kees Cook <keescook@chromium.org> Acked-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * lib: list_sort.c: add a blank line to avoid kernel-doc warningsMauro Carvalho Chehab2019-06-201-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | In order for a list to be recognized as such, blank lines are required. Solve those Sphinx warnings: ./lib/list_sort.c:162: WARNING: Unexpected indentation. ./lib/list_sort.c:163: WARNING: Block quote ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: trace: add a missing blank lineMauro Carvalho Chehab2019-06-201-0/+1
| | | | | | | | | | | | | | | | | | Sphinx expects a blank line after a literal block markup. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org> Acked-by: Masami Hiramatsu <mhiramat@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: fb: Add TER16x32 to the available font namesTakashi Iwai2019-06-201-1/+1
| | | | | | | | | | | | | | | | The new font is available since recently. Signed-off-by: Takashi Iwai <tiwai@suse.de> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Add a document on repository managementJonathan Corbet2019-06-182-0/+227
| | | | | | | | | | | | | | | | | | Every merge window seems to involve at least one episode where subsystem maintainers don't manage their trees as Linus would like. Document the expectations so that at least he has something to point people to. Acked-by: David Rientjes <rientjes@google.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * block: document iostat changes for disk busy time accountingKonstantin Khlebnikov2019-06-141-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | Since commit 5b18b5a73760 ("block: delete part_round_stats and switch to less precise counting") io_ticks is approximated by adding one at each start and end of requests if jiffies has changed. This works perfectly for requests shorter than a jiffy. If requests runs more than 2 jiffies some I/O time will not be accounted unless there are other reuqests. Signed-off-by: Konstantin Khlebnikov <khlebnikov@yandex-team.ru> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/stackprotector: powerpc supports stack protectorBhupesh Sharma2019-06-141-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | powerpc architecture (both 64-bit and 32-bit) supports stack protector mechanism since some time now [see commit 06ec27aea9fc ("powerpc/64: add stack protector support")]. Update stackprotector arch support documentation to reflect the same. Cc: Michael Ellerman <mpe@ellerman.id.au> Signed-off-by: Bhupesh Sharma <bhsharma@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: coresight: Update the generic device namesSuzuki K Poulose2019-06-141-15/+67
| | | | | | | | | | | | | | | | | | | | Update the documentation to reflect the new naming scheme with latest changes. Reported-by: Leo Yan <leo.yan@linaro.org> Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org> Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * sphinx.rst: Add note about code snippets embedded in the textAndré Almeida2019-06-141-1/+1
| | | | | | | | | | | | | | | | | | | | There's a paragraph that explains how to create fixed width text block, but it doesn't explains how to create fixed width text inline, although this feature is really used through the documentation. Fix that adding a quick note about it. Signed-off-by: André Almeida <andrealmeid@collabora.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * scripts/documentation-file-ref-check: ignore output dirMauro Carvalho Chehab2019-06-141-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When there's no Documentation/output directory, the script will complain about those missing references: Documentation/doc-guide/sphinx.rst: Documentation/output Documentation/doc-guide/sphinx.rst: Documentation/output Documentation/process/howto.rst: Documentation/output Documentation/translations/it_IT/doc-guide/sphinx.rst: Documentation/output Documentation/translations/it_IT/doc-guide/sphinx.rst: Documentation/output Documentation/translations/it_IT/process/howto.rst: Documentation/output Documentation/translations/ja_JP/howto.rst: Documentation/output Documentation/translations/ko_KR/howto.rst: Documentation/output Those are false positives, so add an ignore rule for them. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: EDID/HOWTO.txt: convert it and rename to howto.rstMauro Carvalho Chehab2019-06-143-15/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx need to know when a paragraph ends. So, do some adjustments at the file for it to be properly parsed. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. that's said, I believe that this file should be moved to the GPU/DRM documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: scheduler: convert docs to ReST and rename to *.rstMauro Carvalho Chehab2019-06-1416-242/+340
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In order to prepare to add them to the Kernel API book, convert the files to ReST format. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: xilinx: convert eemi.txt to eemi.rstMauro Carvalho Chehab2019-06-142-4/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a very trivial conversion: adjust the title markup and add a few literal block markups to produce a better visual when parsed and avoid warnings. As newer documents related to xilinx could be added in the future, create a new index file for it. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: watchdog: convert docs to ReST and rename to *.rstMauro Carvalho Chehab2019-06-1416-553/+1004
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Convert those documents and prepare them to be part of the kernel API book, as most of the stuff there are related to the Kernel interfaces. Still, in the future, it would make sense to split the docs, as some of the stuff is clearly focused on sysadmin tasks. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Reviewed-by: Guenter Roeck <linux@roeck-us.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: timers: convert docs to ReST and rename to *.rstMauro Carvalho Chehab2019-06-1414-43/+84
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The conversion here is really trivial: just a bunch of title markups and very few puntual changes is enough to make it to be parsed by Sphinx and generate a nice html. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: target: convert docs to ReST and rename to *.rstMauro Carvalho Chehab2019-06-146-270/+328
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Convert the TCM docs to ReST format and add them to the bookset. This has a mix of userspace-faced and Kernelspace faced docs. Still, it sounds a better candidate to be added at the kernel API set of docs. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: riscv: convert docs to ReST and rename to *.rstMauro Carvalho Chehab2019-06-142-46/+69
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The conversion here is trivial: - Adjust the document title's markup - Do some whitespace alignment; - mark literal blocks; - Use ReST way to markup indented lists. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: ptp.txt: convert to ReST and move to driver-apiMauro Carvalho Chehab2019-06-143-10/+20
| | | | | | | | | | | | | | | | | | | | | | | | The conversion is trivial: just adjust title markups. In order to avoid conflicts, let's add an :orphan: tag to it, to be removed when this file gets added to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Richard Cochran <richardcochran@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: pps.txt: convert to ReST and rename to pps.rstMauro Carvalho Chehab2019-06-142-33/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This file is already in a good shape: just its title and adding some literal block markups is needed for it to be part of the document. While it has a small chapter with sysfs stuff, most of the document is focused on driver development. As it describes a kernel API, move it to the driver-api directory. In order to avoid conflicts, let's add an :orphan: tag to it, to be removed when added to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Rodolfo Giometti <giometti@enneenne.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-14 01:43:58 +0100