- Aug 13, 2019
-
-
Jonathan Neuschäfer authored
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>
-
Jonathan Neuschäfer authored
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:
-
- Aug 07, 2019
-
-
Chao Yu authored
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:
-
Todor Tomov authored
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:
-
Chao Yu authored
Add entry to connect all Gao Xiang's email addresses. Signed-off-by:
Gao Xiang <gaoxiang25@huawei.com> Signed-off-by:
-
Colin Ian King authored
There is a minor spelling mistake in the documentation, fix it. Signed-off-by:
Colin Ian King <colin.king@canonical.com> Signed-off-by:
-
Randy Dunlap authored
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:
-
- Aug 01, 2019
-
-
Mauro Carvalho Chehab authored
With all those document shifts, references to documents get broken. Fix one such occurrence at porting.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
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 authored
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 authored
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 authored
The documentation standard is ReST and not markdown. Signed-off-by:
Rob Herring <robh@kernel.org> Signed-off-by:
-
Mauro Carvalho Chehab authored
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:
-
Jarkko Sakkinen authored
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:
-
Mauro Carvalho Chehab authored
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 authored
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 authored
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 authored
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:
Paul Burton <paul.burton@mips.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
Manually convert wimax documentation to ReST and add theit to the Kernel doc body, inside the admin-guide. Signed-off-by:
-
Mauro Carvalho Chehab authored
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 authored
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 authored
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 authored
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 authored
Manually convert the two openRisc documents to ReST, adding them to the Linux documentation body. Signed-off-by:
Stafford Horne <shorne@gmail.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
Manually convert the two PA-RISC documents to ReST, adding them to the Linux documentation body. Signed-off-by:
-
Mauro Carvalho Chehab authored
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 authored
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:
Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
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: 554aae35 ("lib: Add support for generic packing operations") Signed-off-by:
Vladimir Oltean <olteanv@gmail.com> Tested-by:
Mike Rapoport <rppt@linux.ibm.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
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: 51bd6f29 ("Add support for IPMB driver") Signed-off-by:
-
Mauro Carvalho Chehab authored
Convert each file at I2C subsystem, renaming them to .rst and adding to the driver-api book. Signed-off-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:
-
Mauro Carvalho Chehab authored
The documentation standard is ReST and not markdown. Signed-off-by:
-
Mauro Carvalho Chehab authored
The file contents mostly describes driver internals. Signed-off-by:
-
Phong Tran authored
This changes from plain text to reStructuredText as suggestion in doc-guide [1] [1] https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html Some adaptations such as: literal block, ``inline literal`` and alignment text,... Signed-off-by:
Phong Tran <tranmanphong@gmail.com> Reviewed-by:
Mathieu Poirier <mathieu.poirier@linaro.org> Signed-off-by:
-
Shobhit Kukreti authored
This converts the plain text documentation of ufs.txt to reStructuredText format. Added to documentation build process and verified with make htmldocs Signed-off-by:
Shobhit Kukreti <shobhitkukreti@gmail.com> Reviewed-by:
-
Shobhit Kukreti authored
This converts the plain text documentation of jfs.txt to reStructuredText format. Added to documentation build process and verified with make htmldocs Signed-off-by:
-
Federico Vaga authored
Fixed some style inconsistencies and remove old statement referring to kmail missing feature (saving email from the view window is possible). Signed-off-by:
Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by:
-
Mauro Carvalho Chehab authored
Convert this small file to ReST format by: - Using a proper markup for the document title; - marking a code block as such; - use tags for Author and date; - use tables for bit map fields. While here, fix a broken reference for a document with is planned but is not here yet. Signed-off-by:
Atish Patra <atish.patra@wdc.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
There's a broken reference there pointing to the long gone DocBook dir. While I don't read chinese, Google translator translates it to: "The generated documentation will be placed in the Documentation/DocBook/ directory." Well, we know that the output will be Documentation/output dir. So, let's fix this one. Signed-off-by:
-
Mauro Carvalho Chehab authored
changeset fb5772cb ("blkio-controller.txt: Remove references to CFQ") removed cgroup references to CFQ, but it kept one left. Get rid of it. Fixes: fb5772cb ("blkio-controller.txt: Remove references to CFQ") Signed-off-by:
-
Mauro Carvalho Chehab authored
Fix this rename: Documentation/devicetree/bindings/i2c/{i2c-mv64xxx.txt -> marvell,mv64xxx-i2c.yaml} Fixes: f8bbde72 ("dt-bindings: i2c: mv64xxx: Add YAML schemas") Signed-off-by:
-
