- 08 May, 2019 2 commits
-
-
Tzvetomir Stoyanov authored
The current trace documentation, the section describing histogram's "onmatch" is not straightforward enough about how this action is applied. It is not clear what criteria are used to "match" both events. A short note is added, describing what exactly is compared in order to match the events. Signed-off-by:
Tzvetomir Stoyanov <tstoyanov@vmware.com> Reviewed-by:
Steven Rostedt (VMware) <rostedt@goodmis.org> Reviewed-by:
Tom Zanussi <tom.zanussi@linux.intel.com> [jc: fixed trivial conflict with docs-next] Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Federico Vaga authored
This patch translates in Italian the following updates 62be257e LICENSES: Rename other to deprecated 8ea8814f LICENSES: Clearly mark dual license only licenses 6132c37c docs: Don't reference the ZLib license in license-rules.rst Signed-off-by:
Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 07 May, 2019 2 commits
-
-
Petr Mladek authored
Make the structure of "Livepatch module Elf format" document similar to the main "Livepatch" document. Also make the structure of "(Un)patching Callbacks" document similar to the "Shadow Variables" document. It fixes the most visible inconsistencies of the documentation generated from the ReST format. Signed-off-by:
Petr Mladek <pmladek@suse.com> Acked-by:
Joe Lawrence <joe.lawrence@redhat.com> Acked-by:
Josh Poimboeuf <jpoimboe@redhat.com> Acked-by:
Miroslav Benes <mbenes@suse.cz> Reviewed-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Reviewed-by:
Kamalesh Babulal <kamalesh@linux.vnet.ibm.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
Convert livepatch documentation to ReST format. The changes are mostly trivial, as the documents are already on a good shape. Just a few markup changes are needed for Sphinx to properly parse the 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; - The in-file TOC becomes a comment, in order to skip it from the output, as Sphinx already generates an index there. - 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:
Petr Mladek <pmladek@suse.com> Acked-by:
Miroslav Benes <mbenes@suse.cz> Acked-by:
Josh Poimboeuf <jpoimboe@redhat.com> Acked-by:
Joe Lawrence <joe.lawrence@redhat.com> Reviewed-by:
Kamalesh Babulal <kamalesh@linux.vnet.ibm.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 03 May, 2019 5 commits
-
-
Mauro Carvalho Chehab authored
As we keep migrating documents to ReST, we're starting to see more of such tags. Right now, all such tags are pointing to a documentation file, but regressions may be introduced. So, add a check for such kind of issues as well. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
If one tries to run this script under linux-next, it would hit lots of false-positives, due to the tree merges that are stored under the Next/ directory. So, add a logic to ignore it. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Christoph Hellwig authored
Make it clear in the directory name that these are not intended for new code. Signed-off-by:
Christoph Hellwig <hch@lst.de> Reviewed-by:
Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Christoph Hellwig authored
Just like the CDDL the Apache license and the MPL must only be used as a choice in additional to an GPL2 compatible license. Copy over the boilerplate from the CDDL file to the other two after fixing it up to make it clear the licenses need to be GPL2 compatible, not just the more generic GPL compatible. For example the Apache 2 license is GPL3 compatible, but that doesn't matter for the kernel. Also move these licenses to a separate directory and document the rules in license-rules.rst. Signed-off-by:
Christoph Hellwig <hch@lst.de> Reviewed-by:
Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Christoph Hellwig authored
We never had a file called LICENSES/other/ZLib in the tree, so don't reference it. Instead mention the GPL v1 as an (bad) example. Signed-off-by:
Christoph Hellwig <hch@lst.de> Reviewed-by:
Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 30 Apr, 2019 5 commits
-
-
Ralph Campbell authored
Some minor wording changes and typo corrections. Signed-off-by:
Ralph Campbell <rcampbell@nvidia.com> Acked-by:
Randy Dunlap <rdunlap@infradead.org> Acked-by:
Mike Kravetz <mike.kravetz@oracle.com> Cc: Mike Rapoport <rppt@linux.vnet.ibm.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mike Rapoport authored
Describe what {FLAT,DISCONTIG,SPARSE}MEM are and how they manage to maintain pfn <-> struct page correspondence. Signed-off-by:
Mike Rapoport <rppt@linux.ibm.com> Acked-by:
Randy Dunlap <rdunlap@infradead.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Federico Vaga authored
Align Italian translation after the following changes in Documentation bba757d8 coding-style.rst: Generic alloc functions do not need OOM logging d8e8bcc3 docs: doc-guide: remove the extension from .rst files Signed-off-by:
Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Federico Vaga authored
Fix typo in the GPG guide for maintainers Signed-off-by:
Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Masahiro Yamada authored
Add generated *conf-cfg files. Commit 694c49a7 ("kconfig: drop localization support") removed "gconf.glade.h" and "kxgettext". "kconfig" and "lxdialog" should not be excluded either. Signed-off-by:
Masahiro Yamada <yamada.masahiro@socionext.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 19 Apr, 2019 5 commits
-
-
Alex Shi authored
Fixed uncapital issues, thanks for Jonathan Neuschäfer, I am insensitive on captial custom as a non-captial native language reader. Sorry. Also fix a typo. And replace more colloquial words in Chinese. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Reviewed-by:
Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Alex Shi authored
That gives more natural reading experience for Chinese. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Yang Shi authored
When demonstrating FOLL_SPLIT in transhuge document, migration is used as an example. But, since commit 94723aaf ("mm: unclutter THP migration"), the way of THP migration is totally changed. FOLL_SPLIT is not used by migration anymore due to the change. Remove the obsolete example to avoid confusion. Cc: Michal Hocko <mhocko@suse.com> Cc: Kirill A. Shutemov <kirill.shutemov@linux.intel.com> Cc: Mike Rapoport <rppt@linux.vnet.ibm.com> Signed-off-by:
Yang Shi <yang.shi@linux.alibaba.com> Reviewed-by:
Zi Yan <ziy@nvidia.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
On almost all places, we're including ReST files without the extension. Let's remove the extension here as well, in order to use just one standard. Suggested-by:
Jani Nikula <jani.nikula@linux.intel.com> Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Shuah Khan authored
Fix KBUILD_OUTPUT usage instructions. The current documentation is incorrect. Update and fix outdated information about summary option. Add a reference to kselftest wiki for additional information on the framework and tips on writing new tests. Signed-off-by:
Shuah Khan <skhan@linuxfoundation.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 16 Apr, 2019 1 commit
-
-
Mauro Carvalho Chehab authored
There are some warnings produced when building trace. Fix them. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by:
Steven Rostedt (VMware) <rostedt@goodmis.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 11 Apr, 2019 8 commits
-
-
Mauro Carvalho Chehab authored
Identify the example blocks there, in order to avoid Sphinx warnings. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
In order to make it easier to parse and produce the right output, add some extra blank lines. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
This file doesn't follow the documentation style we use within the Kernel. Fix it. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
As all other titles at the documentation, use lower case for its title. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
In order to make it to build with Sphinx, we need to fix the notation for two ascii artwork. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
This document misses a title. Add it, in order to follow the documentation standard. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
This document misses a title. Add it, in order to follow the documentation standard. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
The === line is shorter than the section title. As this will generate a warning with rst build, fix it. Signed-off-by:
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 09 Apr, 2019 3 commits
-
-
Tobin C. Harding authored
Current document includes the path to an RST doc file. Since this is an RST file we can make this a link. Keeps the path as the link title since that what the original author wrote. Use reference to link to rst file. Signed-off-by:
Tobin C. Harding <tobin@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Tobin C. Harding authored
Sphinx emits various warnings all caused by a missing colon before code block: WARNING: Block quote ends without a blank line; unexpected unindent. ERROR: Unexpected indentation. WARNING: Block quote ends without a blank line; unexpected unindent. Add the colon, clearing sphinx warnings. Signed-off-by:
Tobin C. Harding <tobin@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Tobin C. Harding authored
Documentation contains a spelling mistake / typo. s/descibed/described/ Fix spelling mistake. Signed-off-by:
Tobin C. Harding <tobin@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 08 Apr, 2019 2 commits
-
-
Alex Shi authored
"made up" used here means 'fictional' instead of 'consist of'. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Jonathan Neuschäfer authored
It's unnecessary to point to an external mirror of the Documentation directory. Jonathan Corbet writes in favor of removing this entry, instead of moving it under "Docs at the Linux Kernel tree": > We don't want to turn kernel-docs.rst into yet another out-of-date > index for the rest of Documentation/, and the removal of the external > URL takes away the only bit of additional information that this entry > offers. Signed-off-by:
Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 02 Apr, 2019 7 commits
-
-
Jonathan Corbet authored
A reference typo caused an unsightly build error; fix it. Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Alex Shi authored
It's kind of fun to learn and tranlate kernel docs into Chinese. I'd like to help people on this work. And willing to be the 'blamed' people if sth wrong in this area. :) Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Alex Shi authored
The original disclaimer remind people to get help from the specific Chinese doc maintainers. But there are lots docs has no 'specific maintainers' and some of maintainer doesn't updated the docs for years. So replace the Chinese word maintainer with translator. That's more precise for these people's role of their docs. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Alex Shi authored
It's time to link the doc into Chinese version. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Federico Vaga <federico.vaga@vaga.pv.it> Cc: SeongJae Park <sj38.park@gmail.com> Cc: Tom Levy <tomlevy93@gmail.com> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Alex Shi authored
Replace the disclaimer part and give the link name of this file: cn_codingsytle. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Bart Van Assche <bvanassche@acm.org> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Alex Shi authored
It's time to redirect it to Chinese version. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Federico Vaga <federico.vaga@vaga.pv.it> Cc: SeongJae Park <sj38.park@gmail.com> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Alex Shi authored
remove the duplicated disclaimers and maintainers info. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-