openwrt/staging/blogic.git
5 years agoscripts/documentation-file-ref-check: don't parse Next/ dir
Mauro Carvalho Chehab [Mon, 22 Apr 2019 11:42:02 +0000 (08:42 -0300)]
scripts/documentation-file-ref-check: don't parse Next/ dir

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>
5 years agoLICENSES: Rename other to deprecated
Christoph Hellwig [Tue, 30 Apr 2019 10:51:30 +0000 (06:51 -0400)]
LICENSES: Rename other to deprecated

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>
5 years agoLICENSES: Clearly mark dual license only licenses
Christoph Hellwig [Tue, 30 Apr 2019 10:51:29 +0000 (06:51 -0400)]
LICENSES: Clearly mark dual license only licenses

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>
5 years agodocs: Don't reference the ZLib license in license-rules.rst
Christoph Hellwig [Tue, 30 Apr 2019 10:51:28 +0000 (06:51 -0400)]
docs: Don't reference the ZLib license in license-rules.rst

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>
5 years agodocs/vm: Minor editorial changes in the THP and hugetlbfs
Ralph Campbell [Fri, 26 Apr 2019 18:04:29 +0000 (11:04 -0700)]
docs/vm: Minor editorial changes in the THP and hugetlbfs

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>
5 years agodocs/vm: add documentation of memory models
Mike Rapoport [Sun, 28 Apr 2019 12:17:43 +0000 (15:17 +0300)]
docs/vm: add documentation of memory models

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>
5 years agodoc:it_IT: translation alignment
Federico Vaga [Mon, 29 Apr 2019 21:47:20 +0000 (23:47 +0200)]
doc:it_IT: translation alignment

Align Italian translation after the following changes in Documentation

bba757d8578f coding-style.rst: Generic alloc functions do not need OOM logging
d8e8bcc3d8de 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>
5 years agodoc: fix typo in PGP guide
Federico Vaga [Mon, 29 Apr 2019 21:45:14 +0000 (23:45 +0200)]
doc: fix typo in PGP guide

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>
5 years agodontdiff: update with Kconfig build artifacts
Masahiro Yamada [Mon, 29 Apr 2019 14:53:50 +0000 (23:53 +0900)]
dontdiff: update with Kconfig build artifacts

Add generated *conf-cfg files.

Commit 694c49a7c01c ("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>
5 years agodocs/zh_CN: fix typos in 1.Intro.rst file
Alex Shi [Tue, 16 Apr 2019 02:28:25 +0000 (10:28 +0800)]
docs/zh_CN: fix typos in 1.Intro.rst file

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>
5 years agodocs/zh_CN: redirect CoC docs to Chinese version
Alex Shi [Tue, 16 Apr 2019 02:28:24 +0000 (10:28 +0800)]
docs/zh_CN: redirect CoC docs to Chinese version

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>
5 years agodoc: mm: migration doesn't use FOLL_SPLIT anymore
Yang Shi [Thu, 18 Apr 2019 20:17:04 +0000 (04:17 +0800)]
doc: mm: migration doesn't use FOLL_SPLIT anymore

When demonstrating FOLL_SPLIT in transhuge document, migration is used
as an example.  But, since commit 94723aafb9e7 ("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>
5 years agodocs: doc-guide: remove the extension from .rst files
Mauro Carvalho Chehab [Fri, 19 Apr 2019 10:30:51 +0000 (07:30 -0300)]
docs: doc-guide: remove the extension from .rst files

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>
5 years agodoc: kselftest: Fix KBUILD_OUTPUT usage instructions
Shuah Khan [Wed, 17 Apr 2019 23:34:03 +0000 (17:34 -0600)]
doc: kselftest: Fix KBUILD_OUTPUT usage instructions

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>
5 years agodocs: trace: fix some Sphinx warnings
Mauro Carvalho Chehab [Mon, 15 Apr 2019 20:00:05 +0000 (17:00 -0300)]
docs: trace: fix some Sphinx warnings

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>
5 years agodocs: speculation.txt: mark example blocks as such
Mauro Carvalho Chehab [Wed, 10 Apr 2019 09:56:27 +0000 (06:56 -0300)]
docs: speculation.txt: mark example blocks as such

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>
5 years agodocs: ntb.txt: add blank lines to clean up some Sphinx warnings
Mauro Carvalho Chehab [Wed, 10 Apr 2019 09:56:26 +0000 (06:56 -0300)]
docs: ntb.txt: add blank lines to clean up some Sphinx warnings

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>
5 years agodocs: video-output.txt: convert it to ReST format
Mauro Carvalho Chehab [Wed, 10 Apr 2019 09:56:25 +0000 (06:56 -0300)]
docs: video-output.txt: convert it to ReST format

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>
5 years agodocs: unaligned-memory-access.txt: use a lowercase title
Mauro Carvalho Chehab [Wed, 10 Apr 2019 09:56:24 +0000 (06:56 -0300)]
docs: unaligned-memory-access.txt: use a lowercase title

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>
5 years agodocs: ntb.txt: use Sphinx notation for the two ascii figures
Mauro Carvalho Chehab [Wed, 10 Apr 2019 09:56:23 +0000 (06:56 -0300)]
docs: ntb.txt: use Sphinx notation for the two ascii figures

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>
5 years agodocs: clearing-warn-once.txt: add a title for this document
Mauro Carvalho Chehab [Wed, 10 Apr 2019 09:56:22 +0000 (06:56 -0300)]
docs: clearing-warn-once.txt: add a title for this document

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>
5 years agodocs: atomic_bitops.txt: add a title for this document
Mauro Carvalho Chehab [Wed, 10 Apr 2019 09:56:21 +0000 (06:56 -0300)]
docs: atomic_bitops.txt: add a title for this document

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>
5 years agodocs: DMA-API-HOWTO: add a missing "="
Mauro Carvalho Chehab [Wed, 10 Apr 2019 09:56:20 +0000 (06:56 -0300)]
docs: DMA-API-HOWTO: add a missing "="

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>
5 years agodocs: Use reference to link to rst file
Tobin C. Harding [Tue, 9 Apr 2019 00:43:59 +0000 (10:43 +1000)]
docs: Use reference to link to rst file

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>
5 years agodocs: Add colon clearing sphinx warning
Tobin C. Harding [Tue, 9 Apr 2019 00:43:57 +0000 (10:43 +1000)]
docs: Add colon clearing sphinx warning

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>
5 years agodocs: Fix spelling mistake
Tobin C. Harding [Tue, 9 Apr 2019 00:43:56 +0000 (10:43 +1000)]
docs: Fix spelling mistake

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>
5 years agodocs/zh_CN: correct a word in managment-style.
Alex Shi [Mon, 8 Apr 2019 09:18:27 +0000 (17:18 +0800)]
docs/zh_CN: correct a word in managment-style.

"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>
5 years agoDocumentation: kernel-docs: Remove entry for vfs.txt
Jonathan Neuschäfer [Sat, 6 Apr 2019 10:15:27 +0000 (12:15 +0200)]
Documentation: kernel-docs: Remove entry for vfs.txt

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>
5 years agodocs: Fix a build error in coding-style.rst
Jonathan Corbet [Tue, 2 Apr 2019 15:58:08 +0000 (09:58 -0600)]
docs: Fix a build error in coding-style.rst

A reference typo caused an unsightly build error; fix it.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodocs/zh_CN: add Alex Shi as Chinese documentation maintainer
Alex Shi [Mon, 1 Apr 2019 14:45:06 +0000 (22:45 +0800)]
docs/zh_CN: add Alex Shi as Chinese documentation maintainer

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>
5 years agodocs/zh_CN: correct the disclaimer file
Alex Shi [Mon, 1 Apr 2019 14:45:05 +0000 (22:45 +0800)]
docs/zh_CN: correct the disclaimer file

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>
5 years agodocs/zh_CN: redirect coding-sytle to Chinese version
Alex Shi [Mon, 1 Apr 2019 14:45:04 +0000 (22:45 +0800)]
docs/zh_CN: redirect coding-sytle to Chinese version

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>
5 years agodocs/zh_CN: update coding-sytle.rst
Alex Shi [Mon, 1 Apr 2019 14:45:03 +0000 (22:45 +0800)]
docs/zh_CN: update coding-sytle.rst

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>
5 years agodocs/zh_CN: redirect stable-api-nonsense to Chinese version
Alex Shi [Mon, 1 Apr 2019 14:45:02 +0000 (22:45 +0800)]
docs/zh_CN: redirect stable-api-nonsense to Chinese version

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>
5 years agodocs/zh_CN: Cleanup stable-api-nonscense in Chinese
Alex Shi [Mon, 1 Apr 2019 14:45:01 +0000 (22:45 +0800)]
docs/zh_CN: Cleanup stable-api-nonscense in Chinese

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>
5 years agodocs/zh_CN: redirect management-style to Chinese one
Alex Shi [Mon, 1 Apr 2019 14:45:00 +0000 (22:45 +0800)]
docs/zh_CN: redirect management-style to Chinese one

It's time to redirect the link 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>
5 years agodocs/zh_CN: link management-style into process/index
Alex Shi [Mon, 1 Apr 2019 14:44:59 +0000 (22:44 +0800)]
docs/zh_CN: link management-style into process/index

Now we could find it's link after 'make htmldocs' etc.

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>
5 years agodocs/zh_CN: add disclaimer and translator info in management-style
Alex Shi [Mon, 1 Apr 2019 14:44:58 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in management-style

Credit the translator.

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>
5 years agodocs/zh_CN: add management-style.rst in Chinese
Alex Shi [Mon, 1 Apr 2019 14:44:57 +0000 (22:44 +0800)]
docs/zh_CN: add management-style.rst in Chinese

It's a enjoy to read and translate this doc, although I cann't find the
original author from git history -- it came with 2.6.12-rc2, the initial
git repo.

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>
5 years agodocs/zh_CN: redirect the email-clients link to Chinese version
Alex Shi [Mon, 1 Apr 2019 14:44:56 +0000 (22:44 +0800)]
docs/zh_CN: redirect the email-clients link to Chinese version

Since we update the email-clients docs to latest version, it's time to
redirect it in 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: 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>
5 years agodocs/zh_CN: add Alex into translator in email-clients
Alex Shi [Mon, 1 Apr 2019 14:44:55 +0000 (22:44 +0800)]
docs/zh_CN: add Alex into translator in email-clients

Give the credit/responsiblity to translator Alex.
Also remove the duplicate part of disclaimer.

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>
5 years agodocs/zh_CN: Update mutt setting info in email-clients
Alex Shi [Mon, 1 Apr 2019 14:44:54 +0000 (22:44 +0800)]
docs/zh_CN: Update mutt setting info in email-clients

Update mutt setting info into 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>
5 years agodocs/zh_CN: add git setting in email-clients
Alex Shi [Mon, 1 Apr 2019 14:44:53 +0000 (22:44 +0800)]
docs/zh_CN: add git setting in email-clients

Add the Chinese translation of git in email-clients file

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>
5 years agodocs/zh_CN: add disclaimer and translator info into programming-language
Alex Shi [Mon, 1 Apr 2019 14:44:52 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info into programming-language

add disclaimer and translator info into programming-language.rst file

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>
5 years agodocs/zh_CN: link programming-language into process/index
Alex Shi [Mon, 1 Apr 2019 14:44:51 +0000 (22:44 +0800)]
docs/zh_CN: link programming-language into process/index

It could be found in index now.

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>
5 years agodocs/zh_CN: add programming-language.rst
Alex Shi [Mon, 1 Apr 2019 14:44:50 +0000 (22:44 +0800)]
docs/zh_CN: add programming-language.rst

Now we have this file in 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>
5 years agodocs/zh_CN: update co-developed-by info after English version
Alex Shi [Mon, 1 Apr 2019 14:44:49 +0000 (22:44 +0800)]
docs/zh_CN: update co-developed-by info after English version

commit 24a2bb90741b ("docs: Clarify the usage and sign-off requirements for Co-developed-by")
give more info of co-developed-by tag usage. update Chinese docs to
follow it.

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
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>
5 years agodocs/zh_CN: redirect submit-checklist
Alex Shi [Mon, 1 Apr 2019 14:44:48 +0000 (22:44 +0800)]
docs/zh_CN: redirect submit-checklist

Now we has the Chinese version submit-checklist, so redirect it in
Chinese docs.

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
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>
5 years agodocs/zh_CN: redirect the submitting-patches to Chinese doc
Alex Shi [Mon, 1 Apr 2019 14:44:47 +0000 (22:44 +0800)]
docs/zh_CN: redirect the submitting-patches to Chinese doc

Now we have latest Chinese version submitting-patches.rst, it's time to
use it in other docs.

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: James Morris <james.morris@microsoft.com>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodocs/zh_CN: update translator info in submitting-patches
Alex Shi [Mon, 1 Apr 2019 14:44:46 +0000 (22:44 +0800)]
docs/zh_CN: update translator info in submitting-patches

Add Alex as the 2nd translator, and remove duplicated infos.

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
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>
5 years agodocs/zh_CN: update to latest submitting-patches.rst
Alex Shi [Mon, 1 Apr 2019 14:44:45 +0000 (22:44 +0800)]
docs/zh_CN: update to latest submitting-patches.rst

Updated huge changes for this docs. Seems we forget this for decades.
And use local stub to pointer this Chinese docs.

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
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>
5 years agodocs/zh_CN: redirect howto.rst link to Chinese version
Alex Shi [Mon, 1 Apr 2019 14:44:44 +0000 (22:44 +0800)]
docs/zh_CN: redirect howto.rst link to Chinese version

The howto doc is translated from latest version. Now it's time to
point the link to it.

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>
5 years agodocs/zh_CN: redirect license-rules to Chinese doc
Alex Shi [Mon, 1 Apr 2019 14:44:43 +0000 (22:44 +0800)]
docs/zh_CN: redirect license-rules to Chinese doc

The latest license-rules.rst was translated into Chinese. So it's time
to set a link for it.

Also fix typos around SPDX.

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Signed-off-by: Dust Li <dust.li@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>
5 years agodocs/zh_CN: update translator info and comments in howto
Alex Shi [Mon, 1 Apr 2019 14:44:42 +0000 (22:44 +0800)]
docs/zh_CN: update translator info and comments in howto

Since we has disclaimer, don't need duplicate comments.
Add myself into translators.

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>
5 years agodocs/zh_CN: update howto.rst to latest version
Alex Shi [Mon, 1 Apr 2019 14:44:41 +0000 (22:44 +0800)]
docs/zh_CN: update howto.rst to latest version

This removed the obsolete 2.6.x examples, sub-system tree
and updated some links/items following latest Englisht version howto

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>
5 years agodocs/zh_CN: fix link issue in howto.rst
Alex Shi [Mon, 1 Apr 2019 14:44:40 +0000 (22:44 +0800)]
docs/zh_CN: fix link issue in howto.rst

Now we could follow links in created html files.

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>
5 years agodocs/zh_CN: link CoC interpretation into index
Alex Shi [Mon, 1 Apr 2019 14:44:39 +0000 (22:44 +0800)]
docs/zh_CN: link CoC interpretation into index

So people could be easy to find it.

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>
5 years agodocs/zh_CN: add disclaim and translator into CoC interp
Alex Shi [Mon, 1 Apr 2019 14:44:38 +0000 (22:44 +0800)]
docs/zh_CN: add disclaim and translator into CoC interp

That's give translator credit and a way for complain

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>
5 years agodocs/zh_CN: add CoC interpretation
Alex Shi [Mon, 1 Apr 2019 14:44:37 +0000 (22:44 +0800)]
docs/zh_CN: add CoC interpretation

Translated CoC interpretation into 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>
5 years agodocs/zh_CN: link the CoC into process/index
Alex Shi [Mon, 1 Apr 2019 14:44:36 +0000 (22:44 +0800)]
docs/zh_CN: link the CoC into process/index

Let it appears in html links.

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>
5 years agodocs/zh_CN: add disclaimer and translator info in CoC
Alex Shi [Mon, 1 Apr 2019 14:44:35 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in CoC

Give the translator credit and a way people to share complain.

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>
5 years agodocs/zh_CN: add CoC doc
Alex Shi [Mon, 1 Apr 2019 14:44:34 +0000 (22:44 +0800)]
docs/zh_CN: add CoC doc

Translated code-of-conduct doc in 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>
5 years agodocs/zh_CN: link the submit-checklist into process/index
Alex Shi [Mon, 1 Apr 2019 14:44:33 +0000 (22:44 +0800)]
docs/zh_CN: link the submit-checklist into process/index

That's helpful to let people find it in process/index.html.

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>
5 years agodocs/zh_CN: add disclaimer and transtlator info in submit-checklist
Alex Shi [Mon, 1 Apr 2019 14:44:32 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and transtlator info in submit-checklist

Credit the translator and get a way for people to complain.

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>
5 years agodocs/zh_CN: add submit-checklist file
Alex Shi [Mon, 1 Apr 2019 14:44:31 +0000 (22:44 +0800)]
docs/zh_CN: add submit-checklist file

Now it appears in 'make htmldocs' in 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: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodocs/zh_CN: link the license-rules file into process index
Alex Shi [Mon, 1 Apr 2019 14:44:30 +0000 (22:44 +0800)]
docs/zh_CN: link the license-rules file into process index

Make it appear in 'make htmldocs'

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>
5 years agodocs/zh_CN: include Chinese translation header for license-rules
Alex Shi [Mon, 1 Apr 2019 14:44:29 +0000 (22:44 +0800)]
docs/zh_CN: include Chinese translation header for license-rules

Enable the Chinese translation disclaimer and translator 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>
5 years agodocs/zh_CN: fix links failure in license-rules
Alex Shi [Mon, 1 Apr 2019 14:44:28 +0000 (22:44 +0800)]
docs/zh_CN: fix links failure in license-rules

rST doc uses backquote `` to mark a link, which need a space before
and after the backquote sign in Chinese docs. Otherwise the link will be
translated as common context.

Use this patch to highlight this request.

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>
5 years agodocs/zh_CN: add license-rules Chinese translation
Alex Shi [Mon, 1 Apr 2019 14:44:27 +0000 (22:44 +0800)]
docs/zh_CN: add license-rules Chinese translation

This is the first version of license-rules Chinese translation

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>
5 years agodocs/zh_CN: add disclaimer and translator info in 8.Conclusion
Alex Shi [Mon, 1 Apr 2019 14:44:26 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in 8.Conclusion

Give people a link to send comments.

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>
5 years agodocs/zh_CN: add 8.Conclusion.rst in development-process
Alex Shi [Mon, 1 Apr 2019 14:44:25 +0000 (22:44 +0800)]
docs/zh_CN: add 8.Conclusion.rst in development-process

Now, the full developmen-process doc appears in 'make htmldocs' in
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>
5 years agodocs/zh_CN: add disclaimer and translator info in 7.Advancedtopics
Alex Shi [Mon, 1 Apr 2019 14:44:24 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in 7.Advancedtopics

To let people know where to give comments.

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>
5 years agodocs/zh_CN: translate 7.AdvanceTopics.rst
Alex Shi [Mon, 1 Apr 2019 14:44:23 +0000 (22:44 +0800)]
docs/zh_CN: translate 7.AdvanceTopics.rst

This is the 7th doc of development-process. Now we could get Chinese
version in 'make htmldocs'.

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>
5 years agodocs/zh_CN: add disclaimer and translator info in 6.Followthrough
Alex Shi [Mon, 1 Apr 2019 14:44:22 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in 6.Followthrough

To let people know where to complain.

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>
5 years agodocs/zh_CN: add the 6th doc 6.Followthrought.rst
Alex Shi [Mon, 1 Apr 2019 14:44:21 +0000 (22:44 +0800)]
docs/zh_CN: add the 6th doc 6.Followthrought.rst

Now the doc could be found with 'make htmldocs' in 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>
5 years agodocs/zh_CN: add disclaimer and translator info in 5.Posting
Alex Shi [Mon, 1 Apr 2019 14:44:20 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in 5.Posting

To give way for people's comments

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>
5 years agodocs/zh_CN: add 5.Posting.rst into development-process
Alex Shi [Mon, 1 Apr 2019 14:44:19 +0000 (22:44 +0800)]
docs/zh_CN: add 5.Posting.rst into development-process

Since the doc stub was mentained in development-process.rst, it will
appears in 'make htmldocs'.

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>
5 years agodocs/zh_CN: add disclaimer and translator info in 4.Coding
Alex Shi [Mon, 1 Apr 2019 14:44:18 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in 4.Coding

To let people know where to complain.

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>
5 years agodocs/zh_CN: add 4.Coding.rst
Alex Shi [Mon, 1 Apr 2019 14:44:17 +0000 (22:44 +0800)]
docs/zh_CN: add 4.Coding.rst

The file was translated and could be found in developement-process

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>
5 years agodocs/zh_CN: add disclaimer/translator info in 3.Early-stage
Alex Shi [Mon, 1 Apr 2019 14:44:16 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer/translator info in 3.Early-stage

For people reviewing/complain.

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>
5 years agodocs/zh_CN: translate 3.Early-stage of development process
Alex Shi [Mon, 1 Apr 2019 14:44:15 +0000 (22:44 +0800)]
docs/zh_CN: translate 3.Early-stage of development process

Now it is ready to appear in 'make htmldocs'

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>
5 years agodocs/zh_CN: add disclaimer and translator info in 2.Process
Alex Shi [Mon, 1 Apr 2019 14:44:14 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in 2.Process

Now people know where to complain :).

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>
5 years agodocs/zh_CN: add 2.Process.rst for development-process
Alex Shi [Mon, 1 Apr 2019 14:44:13 +0000 (22:44 +0800)]
docs/zh_CN: add 2.Process.rst for development-process

New it's done.

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>
5 years agodocs/zh_CN: add disclaimer and translator info into 1.Intro
Alex Shi [Mon, 1 Apr 2019 14:44:12 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info into 1.Intro

So people know where to complain if the transolation isn't good.

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>
5 years agodocs/zh_CN: add Chinese 1.Intro file
Alex Shi [Mon, 1 Apr 2019 14:44:11 +0000 (22:44 +0800)]
docs/zh_CN: add Chinese 1.Intro file

This is the Chinese version of 1.Intro.rst file.

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>
5 years agodocs/zh_CN: link development-process into process index
Alex Shi [Mon, 1 Apr 2019 14:44:10 +0000 (22:44 +0800)]
docs/zh_CN: link development-process into process index

Then this doc could be find via process index.

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>
5 years agodocs/zh_CN: add disclaimer and translator info in development-process
Alex Shi [Mon, 1 Apr 2019 14:44:09 +0000 (22:44 +0800)]
docs/zh_CN: add disclaimer and translator info in development-process

Add disclaimer and translator info into development process doc

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>
5 years agodocs/zh_CN: translate development-process into Chinese
Alex Shi [Mon, 1 Apr 2019 14:44:08 +0000 (22:44 +0800)]
docs/zh_CN: translate development-process into Chinese

Start development process translation.

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>
5 years agoDocumentation: soundwire: Ensure that code is inside the code blocks
Jonathan Neuschäfer [Sun, 31 Mar 2019 22:34:22 +0000 (00:34 +0200)]
Documentation: soundwire: Ensure that code is inside the code blocks

The way the document is written now, Sphinx renders empty code blocks
followed by the lines that should be inside them.

Unindent the code-block directives to fix this.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodocs: core-api: Drop reference to flexible-arrays
Jonathan Neuschäfer [Sun, 31 Mar 2019 21:41:58 +0000 (23:41 +0200)]
docs: core-api: Drop reference to flexible-arrays

This file doesn't exist anymore.

Fixes: 586187d7de71 ("Drop flex_arrays")
Reviewed-by: Mukesh Ojha <mojha@codeaurora.org>
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodoc:it_IT: translation for maintainer-pgp-guide
Alessia Mantegazza [Sat, 30 Mar 2019 21:19:56 +0000 (22:19 +0100)]
doc:it_IT: translation for maintainer-pgp-guide

It translates the maintainer-pgp-guide in Italian.

Signed-off-by: Alessia Mantegazza <amantegazza@vaga.pv.it>
Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agocoding-style.rst: Generic alloc functions do not need OOM logging
Joe Perches [Sat, 30 Mar 2019 17:25:03 +0000 (10:25 -0700)]
coding-style.rst: Generic alloc functions do not need OOM logging

Generic allocation functions already emit a dump_stack()
so additional error logging isn't useful.

Document it as such and add a reference to the allocation
API.

Signed-off-by: Joe Perches <joe@perches.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodoc:it: alignement clarification about sign-off and Co-developed-by
Federico Vaga [Wed, 27 Mar 2019 22:28:35 +0000 (23:28 +0100)]
doc:it: alignement clarification about sign-off and Co-developed-by

Align Italian documentation after the following patch to the main documents

commit 24a2bb90741b docs: Clarify the usage and sign-off requirements for Co-developed-by

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodocs: scripts/sphinx-pre-install: suggest latexmk for building pdf
Mauro Carvalho Chehab [Sat, 30 Mar 2019 13:45:59 +0000 (10:45 -0300)]
docs: scripts/sphinx-pre-install: suggest latexmk for building pdf

The usage of latexmk improves the PDF output, as it re-run
xelatex when it detects the need, in order to properly generate
indexes and cross-references.

As this is not a mandatory requirement, only suggest its
addition.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodocs: Makefile: use latexmk if available
Mauro Carvalho Chehab [Sat, 30 Mar 2019 13:45:58 +0000 (10:45 -0300)]
docs: Makefile: use latexmk if available

In the past, Sphinx was generating a LaTex Makefile that would
run xelatex 3 times. Running it multiple times is needed in order
to make the indexes right.

However, newer versions of it runs it just once, as it expects
the machine to use the "latexmk" build, with automatically
detects the need for rebuilds.

So, add a logic at the Makefile in order to detect if latexmk
is installed. If so, it will call it.

As an additional bonus, the output of latexmk is a little bit
better, making easier to identify build problems.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agocheckpatch: Warn on improper usage of Co-developed-by
Sean Christopherson [Fri, 22 Mar 2019 21:11:37 +0000 (14:11 -0700)]
checkpatch: Warn on improper usage of Co-developed-by

The purpose of Co-developed-by: is to give attribution to authors who
aren't already attributed by the From: tag, i.e. who aren't the nominal
patch author.  Because Co-developed-by: is essentially a variation of
From:, it must be accompanied by a Signed-off-by: of the associated
co-author.  To ease the burden of determining whether or not co-authors
have signed off, Co-developed-by and Signed-off-by: must be explicitly
paired, i.e. on consecutive lines for a given co-author.

Suggested-by: Joe Perches <joe@perches.com>
Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agoDocumentation: rtc: Correct location of rtctest.c
Joel Stanley [Mon, 25 Mar 2019 10:33:22 +0000 (21:03 +1030)]
Documentation: rtc: Correct location of rtctest.c

The useful little rtctest program moved location a while back.

Fixes: a12ab9e125f1 ("selftests: move RTC tests to rtc subfolder")
Signed-off-by: Joel Stanley <joel@jms.id.au>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodocs: Clarify the usage and sign-off requirements for Co-developed-by
Sean Christopherson [Fri, 22 Mar 2019 21:11:36 +0000 (14:11 -0700)]
docs: Clarify the usage and sign-off requirements for Co-developed-by

The documentation for Co-developed-by is a bit light on details, e.g. it
doesn't explicitly state that:

  - Multiple Co-developed-by tags are perfectly acceptable
  - Co-developed-by and Signed-off-by must be paired together
  - SOB ordering should still follow standard sign-off procedure

Lack of explicit direction has resulted in developers taking a variety
of approaches, often lacking any intent whatsoever, e.g. scattering SOBs
willy-nilly, collecting them all at the end or the beginning, etc...
Tweak the wording to make it clear that multiple co-authors are allowed,
and document the expectation that standard sign-off procedures are to
be followed.

The use of "original author" has also led to confusion as many patches
don't have just one "original" author, e.g. when multiple developers
are involved from the genesis of the patch.  Remove all usage of
"original" and instead call out that Co-developed-by is simply a way to
provide attribution in addition to the From tag, i.e. neither tag is
intended to imply anything with regard to who did what.

Provide examples to (hopefully) eliminate any ambiguity.

Cc: Tobin C. Harding <me@tobin.cc>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Jorge Ramirez-Ortiz <jorge.ramirez-ortiz@linaro.org>
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: Joe Perches <joe@perches.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Niklas Cassel <niklas.cassel@linaro.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodoc: minor fixes to translation's disclaimer
Federico Vaga [Sat, 23 Mar 2019 17:54:16 +0000 (18:54 +0100)]
doc: minor fixes to translation's disclaimer

- move TOC on top because that's the most interesting part
- a couple of minor fixes

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
5 years agodocs: remove spaces from shell variable assignment
Tom Levy [Thu, 21 Mar 2019 01:37:56 +0000 (14:37 +1300)]
docs: remove spaces from shell variable assignment

The instructions for generating patches are given as shell commands
with variables as placeholders. They use the syntax "SRCTREE= linux",
which is wrong for the Bourne shell family (it runs the command
"linux" with the variable "SRCTREE" set to the empty string).

Remove the spaces to avoid confusion. This breaks the pretty alignment
but helps new contributors who try to run the commands as written.

Signed-off-by: Tom Levy <tomlevy93@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>