- 26 Jun, 2020 21 commits
-
-
Mauro Carvalho Chehab authored
The nommu-mmap.txt file provides description of user visible behaviuour. So, move it to the admin-guide. As it is already at the ReST, also rename it. Suggested-by:
Mike Rapoport <rppt@linux.ibm.com> Suggested-by:
Jonathan Corbet <corbet@lwn.net> Signed-off-by:
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/3a63d1833b513700755c85bf3bda0a6c4ab56986.1592918949.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
- Just like some media documents, this file is dual licensed with GPL and GFDL. As right now the GFDL SPDX definition is bogus (as it doesn't tell anything about invariant parts), let's not use SPDX here. Let's use, instead, the same test as we have on media. - Convert title to ReST format; - use :field: markup; - Proper mark literal blocks as such; - Add it to trace/index.rst file. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Adjust document title; - Adjust document and section titles; - Some whitespace fixes and new line breaks; - Mark literal blocks as such; - Add table markups; - Add it to devicetree/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
A new chapter was added to proc.rst. Adjust the markups to avoid this warning: Documentation/filesystems/proc.rst:2194: WARNING: Inconsistent literal block quoting. And to properly mark the code-blocks there. Fixes: 37e7647a ("docs: proc: add documentation for "hidepid=4" and "subset=pid" options and new mount behavior") Signed-off-by:
Kees Cook <keescook@chromium.org> Link: https://lore.kernel.org/r/de67ec04a2e735f4450eb3ce966f7d80b9438244.1592895969.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
As we moved those files to core-api, fix references to point to their newer locations. Signed-off-by:
-
Mauro Carvalho Chehab authored
There's a typo there: w1_generic.rst -> w1-generic.rst Causing the document reference to point to the wrong place. Fixes: e2c94d6f ("w1_therm: adding alarm sysfs entry") Signed-off-by:
-
Mauro Carvalho Chehab authored
The "::" markup is there twice, causing a warning: Documentation/driver-api/driver-model/driver.rst:233: WARNING: Inline emphasis start-string without end-string. Signed-off-by: -
Mauro Carvalho Chehab authored
There are a few issues on this document, when built via the building with ``make htmldocs``: Documentation/powerpc/vas-api.rst:116: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:116: WARNING: Inline emphasis start-string without end-string. Documentation/powerpc/vas-api.rst:117: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:117: WARNING: Inline emphasis start-string without end-string. Documentation/powerpc/vas-api.rst:120: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:124: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:133: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:135: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:150: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:151: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:161: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:176: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:253: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:253: WARNING: Inline emphasis start-string without end-string. Documentation/powerpc/vas-api.rst:259: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:261: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:266: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:267: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:270: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:271: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:273: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:274: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:277: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:278: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:280: WARNING: Unexpected indentation. Documentation/powerpc/vas-api.rst:287: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/powerpc/vas-api.rst:289: WARNING: Block quote ends without a blank line; unexpected unindent. Fixes: c12e38b1 ("Documentation/powerpc: VAS API") Signed-off-by: -
Mauro Carvalho Chehab authored
Some new command line parameters were added at hugetlbpage.rst. Adjust them in order to properly parse that part of the file, avoiding those warnings: Documentation/admin-guide/mm/hugetlbpage.rst:105: WARNING: Unexpected indentation. Documentation/admin-guide/mm/hugetlbpage.rst:108: WARNING: Unexpected indentation. Documentation/admin-guide/mm/hugetlbpage.rst:109: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/admin-guide/mm/hugetlbpage.rst:112: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/admin-guide/mm/hugetlbpage.rst:120: WARNING: Unexpected indentation. Documentation/admin-guide/mm/hugetlbpage.rst:121: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/admin-guide/mm/hugetlbpage.rst:132: WARNING: Unexpected indentation. Documentation/admin-guide/mm/hugetlbpage.rst:135: WARNING: Block quote ends without a blank line; unexpected unindent. Fixes: cd9fa28b5351 ("hugetlbfs: clean up command line processing") Signed-off-by: -
Mauro Carvalho Chehab authored
Changeset 1eecbcdc ("docs: move protection-keys.rst to the core-api book") from Jun 7, 2019 converted protection-keys.txt file to ReST. A recent change at protection_keys.c partially reverted such changeset, causing it to point to a non-existing file: - * Tests x86 Memory Protection Keys (see Documentation/core-api/protection-keys.rst) + * Tests Memory Protection Keys (see Documentation/vm/protection-keys.txt) It sounds to me that the changeset that introduced such change 4645e3563673 ("selftests/vm/pkeys: rename all references to pkru to a generic name") could also have other side effects, as it sounds that it was not generated against uptream code, but, instead, against a version older than Jun 7, 2019. Fixes: 4645e3563673 ("selftests/vm/pkeys: rename all references to pkru to a generic name") Signed-off-by:
-
Mauro Carvalho Chehab authored
One of the kernel-doc markups there have two "note" sections: ./include/linux/kcsan-checks.h:346: warning: duplicate section name 'Note' While this is not the case here, duplicated sections can cause build issues on Sphinx. So, let's change the notes section to use, instead, a list for those 2 notes at the same function. Signed-off-by:
Marco Elver <elver@google.com> Link: https://lore.kernel.org/r/20f7995fab2ba85ce723203e9a7c822a55cca2af.1592895969.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
Changeset 3b0311e7ca71 ("vfs: track per-sb writeback errors and report them to syncfs") added a variant of filemap_sample_wb_err(), but it forgot to rename the arguments at the kernel-doc markup. Fix it. Fix those warnings: ./include/linux/fs.h:2845: warning: Function parameter or member 'file' not described in 'file_sample_sb_err' ./include/linux/fs.h:2845: warning: Excess function parameter 'mapping' description in 'file_sample_sb_err' Fixes: 3b0311e7ca71 ("vfs: track per-sb writeback errors and report them to syncfs") Signed-off-by:Jan Kara <jack@suse.cz> Link: https://lore.kernel.org/r/7b33bbceb29ac80874622a2bc84127bb10103245.1592895969.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
There are some function pointer prototypes inside the net includes, like this one: int (*pcs_config)(struct phylink_config *config, unsigned int mode, phy_interface_t interface, const unsigned long *advertising); There's nothing wrong using it with kernel-doc, but we need to add a rule for it to parse such kind of prototype. Signed-off-by:
-
Mauro Carvalho Chehab authored
Some fields were moved from struct phylink into phylink_config. Update the kernel-doc markups for the config struct accordingly Fixes: 5c05c1db ("net: phylink, dsa: eliminate phylink_fixed_state_cb()") Reviewed-by:
Russell King <rmk+kernel@armlinux.org.uk> Signed-off-by:
-
Mauro Carvalho Chehab authored
The __ETHTOOL_DECLARE_LINK_MODE_MASK macro is a variant of DECLARE_BITMAP(), used by phylink.h. As we have already a parser for DECLARE_BITMAP(), let's add one for this macro, in order to avoid such warnings: ./include/linux/phylink.h:54: warning: Function parameter or member '__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising' not described in 'phylink_link_state' ./include/linux/phylink.h:54: warning: Function parameter or member '__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising' not described in 'phylink_link_state' Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset 6f8b12d6 ("net: napi: add hard irqs deferral feature") added a new element at struct net_device. Add a description for it, based on what's described at the changeset which added such feature. Fixes: 6f8b12d6 ("net: napi: add hard irqs deferral feature") Signed-off-by:
-
Mauro Carvalho Chehab authored
The dev argument was not listed at kernel-doc markup: ./net/core/dev.c:7878: warning: Function parameter or member 'dev' not described in 'netdev_get_xmit_slave' Signed-off-by:
-
Jonathan Corbet authored
Bring a handful of (relatively) urgent fixes into docs-next as well.
-
Jiri Slaby authored
There were enough problems with suse.{com,cz} MTAs recently. I am bored by restoring lost e-mails from public archives. Let's switch (all) my MAINTAINERS addresses to @kernel.org and forward the e-mails there as I wish. And add the whole history to .mailmap. Signed-off-by:Jiri Slaby <jslaby@suse.cz> Cc: Joe Perches <joe@perches.com> Link: https://lore.kernel.org/r/20200623080919.19976-1-jslaby@suse.czSigned-off-by:
-
Jonathan Corbet authored
Commit ed318a6c ("fscrypt: support test_dummy_encryption=v2") added an entry to the massive option table in Documentation/filesystems/f2fs.txt. The option was too wide for the formatting of the table, though, leading to a verbose and ugly warning starting with: Documentation/filesystems/f2fs.rst:229: WARNING: Malformed table. Text in column margin in table line 126. Fixing this requires formatting the whole table; let's hear it for Emacs query-replace-regexp. Fixes: ed318a6c ("fscrypt: support test_dummy_encryption=v2") Signed-off-by:
-
Jonathan Corbet authored
The sphinx-pre-install script will put out a verbose message recommending an upgrade for anybody running less than 2.4.4 - which was only released in March. So *everybody* will see that warning at this point. Let's only warn if the user is below our generally recommended version (1.7.9 currently). It might be good to put out a warning if people are explicitly making PDF files, but would need to be done in a different place and relatively few people do that. Signed-off-by:
-
- 22 Jun, 2020 1 commit
-
-
André Almeida authored
Create a documentation providing a background and explanation around the operation of the Multi-Queue Block IO Queueing Mechanism (blk-mq). The reference for writing this documentation was the source code and "Linux Block IO: Introducing Multi-queue SSD Access on Multi-core Systems", by Axboe et al. Signed-off-by:
André Almeida <andrealmeid@collabora.com> Reviewed-by:
Jens Axboe <axboe@kernel.dk> Acked-by:
Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20200620002036.113000-1-andrealmeid@collabora.comSigned-off-by:
-
- 19 Jun, 2020 18 commits
-
-
Mauro Carvalho Chehab authored
Such directive cause troubles with PDF output. Signed-off-by:
-
Mauro Carvalho Chehab authored
There are several files that I was unable to find a proper place for them, and 3 ones that are still in plain old text format. Let's place those stuff behind the carpet, as we'd like to keep the root directory clean. We can later discuss and move those into better places. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Adjust document title to follow ReST style; - Add blank lines to make ReST markup happy - Add it to sh/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Adjust document title to follow ReST style; - Mark literal blocks as such; - Mark a table as such; - Add it to sh/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Use standard markup for document title; - Adjust identation on lists and add blank lines where needed; - Add it to the powerpc index.rst file. Acked-by: Michael Ellerman <mpe@ellerman.id.au> # powerpc Signed-off-by:
-
Mauro Carvalho Chehab authored
This file is almost in ReST. All it needs is a rename and adding a :field: for the two fields at the beginning (author and date). While here, add a proper SPDX header, and use the standard markup for document titles, just for consistency. Signed-off-by:
-
Mauro Carvalho Chehab authored
Convert this file to ReST by adding a proper title to it and use the right markups for a table. While here, add a SPDX header. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Adjust title markup; - Adjust identation. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Adjust document title markup; - use list markups; - Adjust identations to display properly at ReST output. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Use copyright symbol; - use title markups; - adjust indentation; - mark literal blocks as such. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Use titles markups; - Adjust identation; - use literal markup; - Use the proper notation for footnotes. Signed-off-by:
-
Mauro Carvalho Chehab authored
- use title markups; - mark literal blocks. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Use title/chapter markups; - Use table markups; - Mark literal blocks as such; - Adjust indentation. Signed-off-by:
-
Mauro Carvalho Chehab authored
Convert this readme file to ReST file format, preserving its contents as-is as much as possible. The only changes are: - Added chapter and title markups; - Added blank lines where needed; - Added list markups where needed; - Use a table markup; - replace markups like `foo' to ``foo``; - add one extra literal markup to avoid warnings. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Place the txt index inside a comment; - Use title and chapter markups; - Adjust markups for numbered list; - Mark literal blocks as such; - Use tables markup. - Adjust indentation when needed. Acked-By: Vinod Koul <vkoul@kernel.org> # dmaengine Signed-off-by:
-
Mauro Carvalho Chehab authored
- Change title markups; - Mark literal blocks; - Use list markups at authors/credits; - Add blank lines when needed; - Remove trailing whitespaces. Signed-off-by:
-
Mauro Carvalho Chehab authored
This file is almost compatible with ReST. Just minor changes were needed: - Adjust document and titles markups; - Adjust numbered list markups; - Add a comments markup for the Contents section; - Add markups for literal blocks. Acked-by:
Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
Despite being named with .rst extension, this file doesn't match the ReST standard. It actually causes a crash at Sphinx: Sphinx parallel build error: docutils.utils.SystemMessage: /devel/v4l/docs/Documentation/driver-api/thermal/cpu-idle-cooling.rst:69: (SEVERE/4) Unexpected section title. Add needed markups for it to be properly parsed. Signed-off-by:
-
