Vegard Nossum
40d35bf963
docs: doc-guide: mention 'make refcheckdocs'
...
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 >
2023-10-22 20:38:55 -06:00
Krzysztof Kozlowski
f1a693994b
Documentation/process: use scripts/get_maintainer.pl on patches
...
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 >
2022-05-09 16:12:16 -06:00
Mauro Carvalho Chehab
fd88d2e598
docs: doc-guide: avoid using ReST :doc:foo markup
...
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 >
2021-06-17 13:24:37 -06:00
Sameer Rahmani
ff1e81a7e2
Documentation: build warnings related to missing blank lines after explicit 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 >
2020-02-05 10:30:03 -07:00
Jonathan Corbet
d96574b0b4
Add a document on how to contribute to the documentation
...
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 >
2020-01-24 09:48:14 -07:00
