summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'docs-5.4' of git://git.lwn.net/linuxLinus Torvalds2019-09-18249-3963/+5169
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull documentation updates from Jonathan Corbet: "It's a somewhat calmer cycle for docs this time, as the churn of the mass RST conversion is happily mostly behind us. - A new document on reproducible builds. - We finally got around to zapping the documentation for hardware support that was removed in 2004; one doesn't want to rush these things. - The usual assortment of fixes, typo corrections, etc" * tag 'docs-5.4' of git://git.lwn.net/linux: (67 commits) Documentation: kbuild: Add document about reproducible builds docs: printk-formats: Stop encouraging use of unnecessary %h[xudi] and %hh[xudi] Documentation: Add "earlycon=sbi" to the admin guide doc:lock: remove reference to clever use of read-write lock devices.txt: improve entry for comedi (char major 98) docs: mtd: Update spi nor reference driver doc: arm64: fix grammar dtb placed in no attributes region Documentation: sysrq: don't recommend 'S' 'U' before 'B' mailmap: Update email address for Quentin Perret docs: ftrace: clarify when tracing is disabled by the trace file docs: process: fix broken link Documentation/arm/samsung-s3c24xx: Remove stray U+FEFF character to fix title Documentation/arm/sa1100/assabet: Fix 'make assabet_defconfig' command Documentation/arm/sa1100: Remove some obsolete documentation docs/zh_CN: update Chinese howto.rst for latexdocs making Documentation: virt: Fix broken reference to virt tree's index docs: Fix typo on pull requests guide kernel-doc: Allow anonymous enum Documentation: sphinx: Don't parse socket() as identifier reference Documentation: sphinx: Add missing comma to list of strings ...
| * Documentation: kbuild: Add document about reproducible buildsBen Hutchings2019-09-152-0/+123
| | | | | | | | | | | | | | | | | | | | | | | | | | | | In the Distribution Kernels track at Linux Plumbers Conference there was some discussion around the difficulty of making kernel builds reproducible. This is a solved problem, but the solutions don't appear to be documented in one place. This document lists the issues I know about and the settings needed to ensure reproducibility. Signed-off-by: Ben Hutchings <ben@decadent.org.uk> Acked-by: Masahiro Yamada <yamada.masahiro@socionext.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: printk-formats: Stop encouraging use of unnecessary %h[xudi] and %hh[xudi]Joe Perches2019-09-141-8/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Standard integer promotion is already done and %hx and %hhx is useless so do not encourage the use of %hh[xudi] or %h[xudi]. As Linus said in: https://lore.kernel.org/lkml/CAHk-=wgoxnmsj8GEVFJSvTwdnWm8wVJthefNk2n6+4TC=20e0Q@mail.gmail.com/ It's a pointless warning, making for more complex code, and making people remember esoteric printf format details that have no reason for existing. The "h" and "hh" things should never be used. The only reason for them being used if if you have an "int", but you want to print it out as a "char" (and honestly, that is a really bad reason, you'd be better off just using a proper cast to make the code more obvious). So if what you have a "char" (or unsigned char) you should always just print it out as an "int", knowing that the compiler already did the proper type conversion. Signed-off-by: Joe Perches <joe@perches.com> Reviewed-by: Louis Taylor <louis@kragniz.eu> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: Add "earlycon=sbi" to the admin guidePalmer Dabbelt2019-09-141-0/+4
| | | | | | | | | | | | | | | | This argument is supported on RISC-V systems and widely used, but was not documented here. Signed-off-by: Palmer Dabbelt <palmer@sifive.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc:lock: remove reference to clever use of read-write lockFederico Vaga2019-09-141-12/+0
| | | | | | | | | | | | | | | | | | | | Remove the clever example about read-write lock because this type of lock is not recommended anymore (according to the very same document). So there is no reason to teach clever things that people should not do. Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Acked-by: Will Deacon <will@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * devices.txt: improve entry for comedi (char major 98)Ian Abbott2019-09-141-1/+10
| | | | | | | | | | | | | | | | | | | | | | Describe how the comedi minor device numbers are split across comedi devices and comedi subdevices. Replace the current, long dead URL with an official URL for the Comedi project. Signed-off-by: Ian Abbott <abbotti@mev.co.uk> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: mtd: Update spi nor reference driverJohn Garry2019-09-061-1/+1
| | | | | | | | | | | | | | | | | | | | The reference driver no longer exists since commit 50f1242c6742 ("mtd: fsl-quadspi: Remove the driver as it was replaced by spi-fsl-qspi.c"). Update reference to spi-fsl-qspi.c driver. Signed-off-by: John Garry <john.garry@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: arm64: fix grammar dtb placed in no attributes regionlixianfa2019-09-061-2/+2
| | | | | | | | | | | | | | | | Fix grammar dtb placed in no attributes region. This makes Chinese translation smooth to read. Signed-off-by: lixinafa <lixinafa.official@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: sysrq: don't recommend 'S' 'U' before 'B'Adam Borowski2019-09-061-11/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | This advice is obsolete and slightly harmful for filesystems from this millenium: any modern filesystem can handle unexpected crashes without requiring fsck -- and on the other hand, trying to write to the disk when the kernel is in a bad state risks introducing corruption. For ext2, any unsafe shutdown meant widespread breakage, but it's no longer a reasonable filesystem for any non-special use. Signed-off-by: Adam Borowski <kilobyte@angband.pl> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * mailmap: Update email address for Quentin PerretQuentin Perret2019-09-061-5/+6
| | | | | | | | | | | | | | | | | | | | | | | | My @arm.com email address will stop working in a few weeks, so add an entry to .mailmap so others have a way to reach me if they want to. While at it, move some entries around to keep the file in alphabetical order. Signed-off-by: Quentin Perret <quentin.perret@arm.com> Acked-by: Will Deacon <will@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: ftrace: clarify when tracing is disabled by the trace filePeter Wu2019-09-021-4/+9
| | | | | | | | | | | | | | | | | | | | | | The current text could mislead the user into believing that only read() disables tracing. Clarify that any open() call that requests read access disables tracing. Link: https://lkml.kernel.org/r/CAADnVQ+hU6QOC_dPmpjnuv=9g4SQEeaMEMqXOS2WpMj=q=LdiQ@mail.gmail.com Signed-off-by: Peter Wu <peter@lekensteyn.nl> Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: process: fix broken linkJacob Huisman2019-08-249-9/+9
| | | | | | | | | | | | | | | | | | | | http://linux.yyz.us/patch-format.html seems to be down since approximately September 2018. There is a working archive copy on arhive.org. Replaced the links in documenation + translations. Signed-off-by: Jacob Huisman <jacobhuisman@kernelthusiast.com> Reviewed-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/arm/samsung-s3c24xx: Remove stray U+FEFF character to fix titleJonathan Neuschäfer2019-08-121-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | It seems a UTF-8 byte order mark (the least useful kind of BOM...) snuck into the file and broke Sphinx's detection of the title line. Besides making arm/samsung-s3c24xx/index.html look a little better, this patch also confines the non-index pages in arm/samsung-s3c24xx to their own table of contents. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/arm/sa1100/assabet: Fix 'make assabet_defconfig' commandJonathan Neuschäfer2019-08-121-1/+1
| | | | | | | | | | | | | | "make assabet_config" doesn't work. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/arm/sa1100: Remove some obsolete documentationJonathan Neuschäfer2019-08-1213-452/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The support for the following boards, among others, was removed in 2004 with commit "[ARM] Remove broken SA1100 machine support.": - ADS Bitsy - Brutus - Freebird - ADS GraphicsClient Plus - ADS GraphicsMaster - Höft & Wessel Webpanel - Compaq Itsy - nanoEngine - Pangolin - PLEB - Yopy Tifon support has been removed in 2.4.3.3. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: update Chinese howto.rst for latexdocs makingAlex Shi2019-08-121-4/+8
| | | | | | | | | | | | | | | | | | | | | | | | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> found a reference error in Chinese howto.rst. and further more there more infos of latexdocs/epubdocs format doc making in English howto.rst. So I update this part according to latest howto.rst and settled the correct reference. Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: virt: Fix broken reference to virt tree's indexSheriff Esseson2019-08-121-1/+1
| | | | | | | | | | | | | | | | Fix broken reference to virt/index.rst. Fixes: 2f5947dfcaec ("Documentation: move Documentation/virtual to Documentation/virt") Signed-off-by: Sheriff Esseson <sheriffesseson@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Fix typo on pull requests guideMarco Villegas2019-08-121-1/+1
| | | | | | | | | | Signed-off-by: Marco Villegas <git@marvil07.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * kernel-doc: Allow anonymous enumAndy Shevchenko2019-08-121-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | In C is a valid construction to have an anonymous enumerator. Though we have now: drivers/pinctrl/intel/pinctrl-intel.c:240: error: Cannot parse enum! Support it in the kernel-doc script. Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: sphinx: Don't parse socket() as identifier referenceJonathan Neuschäfer2019-08-121-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the introduction of Documentation/sphinx/automarkup.py, socket() is parsed as a reference to the in-kernel definition of socket. Sphinx then decides that struct socket is a good match, which is usually not intended, when the syscall is meant instead. This was observed in Documentation/networking/af_xdp.rst. Prevent socket() from being misinterpreted by adding it to the Skipfuncs list in automarkup.py. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: sphinx: Add missing comma to list of stringsJonathan Neuschäfer2019-08-121-1/+1
| | | | | | | | | | | | | | | | | | | | In Python, like in C, when a comma is omitted in a list of strings, the two strings around the missing comma are concatenated. Cc: stable@vger.kernel.org # v5.2 only Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * mailmap: add entry for Jaegeuk KimChao Yu2019-08-061-0/+3
| | | | | | | | | | | | | | | | Add entry to connect all Jaegeuk's email addresses. Acked-by: Jaegeuk Kim <jaegeuk@kernel.org> Signed-off-by: Chao Yu <yuchao0@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * mailmap: Add an entry for my email addressTodor Tomov2019-08-061-0/+1
| | | | | | | | | | | | | | | | My @linaro.org email address doesn't exist anymore so add a mailmap entry to map it to my @gmail.com address. Signed-off-by: Todor Tomov <todor.too@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * mailmap: add entry for Gao XiangChao Yu2019-08-061-0/+2
| | | | | | | | | | | | | | | | Add entry to connect all Gao Xiang's email addresses. Signed-off-by: Chao Yu <yuchao0@huawei.com> Acked-by: Gao Xiang <gaoxiang25@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Input: docs: fix spelling mistake "potocol" -> "protocol"Colin Ian King2019-08-061-1/+1
| | | | | | | | | | | | | | There is a minor spelling mistake in the documentation, fix it. Signed-off-by: Colin Ian King <colin.king@canonical.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * kernel-doc: ignore __printf attributeRandy Dunlap2019-08-061-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Ignore __printf() function attributes just as other __attribute__ strings are ignored. Fixes this kernel-doc warning message: include/kunit/kunit-stream.h:58: warning: Function parameter or member '2' not described in '__printf' Reported-by: kbuild test robot <lkp@intel.com> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Brendan Higgins <brendanhiggins@google.com> Tested-by: Brendan Higgins <brendanhiggins@google.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: fs: porting.rst: fix a broken reference to another docMauro Carvalho Chehab2019-07-311-1/+1
| | | | | | | | | | | | | | | | | | | | With all those document shifts, references to documents get broken. Fix one such occurrence at porting.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: w1: convert to ReST and add to the kAPI group of docsMauro Carvalho Chehab2019-07-3123-169/+308
| | | | | | | | | | | | | | | | | | The 1wire documentation was written with w1 developers in mind, so, it makes sense to add it together with the driver-api set. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: fs: cifs: convert to ReST and add to admin-guide bookMauro Carvalho Chehab2019-07-319-288/+461
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The filenames for cifs documentation is not using the same convention as almost all Kernel documents is using. So, rename them to a more appropriate name. Then, manually convert the documentation files for CIFS to ReST. By doing a manual conversion, we can preserve the original author's style, while making it to look more like the other Kernel documents. Most of the conversion here is trivial. The most complex one was the README file (which was renamed to usage.rst). Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * spi: docs: convert to ReST and add it to the kABI booksetMauro Carvalho Chehab2019-07-3113-129/+198
| | | | | | | | | | | | | | | | | | | | While there's one file there with briefily describes the uAPI, the documentation was written just like most subsystems: focused on kernel developers. So, add it together with driver-api books. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for iio Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: writing-schema.md: convert from markdown to ReSTMauro Carvalho Chehab2019-07-312-130/+153
| | | | | | | | | | | | | | | | The documentation standard is ReST and not markdown. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: fix a couple of new broken referencesMauro Carvalho Chehab2019-07-315-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Those are due to recent changes. Most of the issues can be automatically fixed with: $ ./scripts/documentation-file-ref-check --fix The only exception was the sound binding with required manual work. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * tpm: Document UEFI event log quirksJarkko Sakkinen2019-07-312-0/+56
| | | | | | | | | | | | | | | | | | There are some weird quirks when it comes to UEFI event log. Provide a brief introduction to TPM event log mechanism and describe the quirks and how they can be sorted out. Signed-off-by: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: net: convert two README files to ReST formatMauro Carvalho Chehab2019-07-313-37/+81
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are two README files there with doesn't have a .txt extension nor are at ReST format. In order to help with the docs conversion to ReST, rename those and manually convert them to ReST format. As there are lot more to be done for networking to be part of the documentation body, for now mark those two files with :orphan:, in order to supress a build warning. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: nios2: add it to the main Documentation bodyMauro Carvalho Chehab2019-07-312-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | Rename and add the nios2 documentation to the documentation body. The nios2 document is already on an ReST compatible format. All it needs is that the title of the document to be promoted one level. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: hwmon: pxe1610: convert to ReST format and add to the indexMauro Carvalho Chehab2019-07-312-8/+26
| | | | | | | | | | | | | | | | This document was recently introduced. Convert it to ReST just like the other hwmon documents, adding it to the hwmon index. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: mips: add to the documentation body as ReSTMauro Carvalho Chehab2019-07-313-37/+70
| | | | | | | | | | | | | | | | | | Manually convert the AU1xxx_IDE.README file to ReST and add to a MIPS book as part of the main documentation body. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Paul Burton <paul.burton@mips.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: wimax: convert to ReST and add to admin-guideMauro Carvalho Chehab2019-07-315-78/+129
| | | | | | | | | | | | | | | | Manually convert wimax documentation to ReST and add theit to the Kernel doc body, inside the admin-guide. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: index.rst: don't use genindex for pdf outputMauro Carvalho Chehab2019-07-316-6/+6
| | | | | | | | | | | | | | | | | | The genindex logic is meant to be used only for html output, as pdf build has its own way to generate indexes. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Vinod Koul <vkoul@kernel.org> # dmaengine and soundwire Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: fs: convert porting to ReSTMauro Carvalho Chehab2019-07-314-687/+855
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This file has its own proper style, except that, after a while, the coding style gets violated and whitespaces are placed on different ways. As Sphinx and ReST are very sentitive to whitespace differences, I had to opt if each entry after required/mandatory/... fields should start with zero spaces or with a tab. I opted to start them all from the zero position, in order to avoid needing to break lines with more than 80 columns, with would make harder for review. Most of the other changes at porting.rst were made to use an unified notation with works nice as a text file while also produce a good html output after being parsed. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: fs: convert docs without extension to ReSTMauro Carvalho Chehab2019-07-3111-120/+226
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are 3 remaining files without an extension inside the fs docs dir. Manually convert them to ReST. In the case of the nfs/exporting.rst file, as the nfs docs aren't ported yet, I opted to convert and add a :orphan: there, with should be removed when it gets added into a nfs-specific part of the fs documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: isdn: convert to ReST and add to kAPI booksetMauro Carvalho Chehab2019-07-319-327/+532
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The ISDN documentation is a mix of admin guide, uAPI and kAPI. Ideally, it should be split. Yet, not sure if it would worth the troble. Anyway, we have the same kind of mix on several drivers specific documentation. So, just like the others, keep the directory at the root Documentation/ tree, just adding a pointer to it at the kAPI section, as the documentation was written with the Kernel developers in mind. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: openrisc: convert to ReST and add to documentation bodyMauro Carvalho Chehab2019-07-314-10/+43
| | | | | | | | | | | | | | | | | | Manually convert the two openRisc documents to ReST, adding them to the Linux documentation body. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Stafford Horne <shorne@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: parisc: convert to ReST and add to documentation bodyMauro Carvalho Chehab2019-07-314-17/+68
| | | | | | | | | | | | | | | | Manually convert the two PA-RISC documents to ReST, adding them to the Linux documentation body. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: README.buddha: convert to ReST and add to m68k bookMauro Carvalho Chehab2019-07-312-48/+48
| | | | | | | | | | | | | | | | Adjust the file for it to be properly parsed by Sphinx, adding it to the index of the book it belongs. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: admin-guide: add auxdisplay files to it after conversion to ReSTMauro Carvalho Chehab2019-07-318-162/+167
| | | | | | | | | | | | | | | | | | | | Those two files describe userspace-faced information. While part of it might fit on uAPI, it sounds to me that the admin guide is the best place for them. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: packing: move it to core-api book and adjust markupsMauro Carvalho Chehab2019-07-313-33/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The packing.txt file was misplaced, as docs should be part of a documentation book, and not at the root dir. So, move it to the core-api directory and add to its index. Also, ensure that the file will be properly parsed and the bitmap ascii artwork will use a monotonic font. Fixes: 554aae35007e ("lib: Add support for generic packing operations") Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Reviewed-by: Vladimir Oltean <olteanv@gmail.com> Tested-by: Vladimir Oltean <olteanv@gmail.com> Reviewed-by: Mike Rapoport <rppt@linux.ibm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: ipmb: place it at driver-api and convert to ReSTMauro Carvalho Chehab2019-07-311-0/+1
| | | | | | | | | | | | | | | | | | | | | | No new doc should be added at the main Documentation/ directory. Instead, new docs should be added as ReST files, within the Kernel documentation body. Fixes: 51bd6f291583 ("Add support for IPMB driver") Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: i2c: convert to ReST and add to driver-api booksetMauro Carvalho Chehab2019-07-3183-789/+1095
| | | | | | | | | | | | | | | | | | | | | | Convert each file at I2C subsystem, renaming them to .rst and adding to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Wolfram Sang <wsa@the-dreams.de> Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: ubifs-authentication.md: convert to ReSTMauro Carvalho Chehab2019-07-311-26/+44
| | | | | | | | | | | | | | | | The documentation standard is ReST and not markdown. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-27 22:08:49 +0100