summaryrefslogtreecommitdiffstats
path: root/Documentation/doc-guide/contributing.rst
Commit message (Collapse)AuthorAgeFilesLines
* docs: doc-guide: mention 'make refcheckdocs'Vegard Nossum2023-10-221-0/+4
| | | | | | | | | | Add this to the section on fixing warnings. Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20231022184910.919201-1-vegard.nossum@oracle.com>
* Documentation/process: use scripts/get_maintainer.pl on patchesKrzysztof Kozlowski2022-05-091-2/+3
| | | | | | | | | | | Explain that, when collecting list of people to Cc the patch, scripts/get_maintainer.pl should be used on patches, not on the directories. The behavior is quite different, because with "-f" on a directory, the maintainers of individual files will not be shown. Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Link: https://lore.kernel.org/r/20220427185645.677039-1-krzysztof.kozlowski@linaro.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: doc-guide: avoid using ReST :doc:`foo` markupMauro Carvalho Chehab2021-06-171-4/+4
| | | | | | | | | The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/d6cbe5183406e3378ed4bd0f84f4bcf85a15009c.1623824363.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: build warnings related to missing blank lines after explicit ↵Sameer Rahmani2020-02-051-0/+1
| | | | | | | | | | | | | | markups has been fixed Fix for several documentation build warnings related to missing blank lines after explicit mark up. Exact warning message: WARNING: Explicit markup ends without a blank line; unexpected unindent. Signed-off-by: Sameer Rahmani <lxsameer@gnu.org> Link: https://lore.kernel.org/r/20200203201543.24834-1-lxsameer@gnu.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Add a document on how to contribute to the documentationJonathan Corbet2020-01-241-0/+294
This is mostly a collection of thoughts for how people who want to help out can make the docs better. Hopefully the world will respond with a flurry of useful patches. Acked-by: Jani Nikula <jani.nikula@intel.com> Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>