kernel/linux.git/Documentation/doc-guide/parse-headers.rst, branch v6.18.21

doc: fix spelling about ReStructured Text

2024-04-02T16:07:51+00:00

- ReStructured Text should be exactly reStructuredText - "reStructuredText" is ONE word, not two! according to https://docutils.sourceforge.io/rst.html Signed-off-by: Maki Hatano Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20240323062141.14863-1-Maki.Y.Hatano@gmail.com

Merge tag 'docs-5.8-2' of git://git.lwn.net/linux

2020-06-10T21:12:15+00:00

Pull more documentation updates from Jonathan Corbet: "A handful of late-arriving docs fixes, along with a patch changing a lot of HTTP links to HTTPS that had to be yanked and redone before the first pull" * tag 'docs-5.8-2' of git://git.lwn.net/linux: docs/memory-barriers.txt/kokr: smp_mb__{before,after}_atomic(): update Documentation Documentation: devres: add missing entry for devm_platform_get_and_ioremap_resource() Replace HTTP links with HTTPS ones: documentation docs: it_IT: address invalid reference warnings doc: zh_CN: use doc reference to resolve undefined label warning docs: Update the location of the LF NDA program docs: dev-tools: coccinelle: underlines

Replace HTTP links with HTTPS ones: documentation

2020-06-08T15:30:19+00:00

Rationale: Reduces attack surface on kernel devs opening the links for MITM as HTTPS traffic is much harder to manipulate. Deterministic algorithm: For each file: For each line: If doesn't contain `\bxmlns\b`: For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`: If both the HTTP and HTTPS versions return 200 OK and serve the same content: Replace HTTP with HTTPS. Signed-off-by: Alexander A. Klimov Link: https://lore.kernel.org/r/20200526060544.25127-1-grandmaster@al2klimov.de Signed-off-by: Jonathan Corbet

media: docs: move uAPI book to userspace-api/media

2020-04-14T08:31:49+00:00

Since 2017, there is an space reserved for userspace API, created by changeset 1d596dee3862 ("docs: Create a user-space API guide"). As the media subsystem was one of the first subsystems to use Sphinx, until this patch, we were keeping things on a separate place. Let's just use the new location, as having all uAPI altogether will likely make things easier for developers. Signed-off-by: Mauro Carvalho Chehab

doc:sphinx: fix parse-header description

2018-06-26T15:07:57+00:00

The description speaks about the option ``--man`` but it does not exist. Instead, there is the option ``--usage`` $ ./Documentation/sphinx/parse-headers.pl --man Unknown option: man Usage: parse_headers.pl [] [] Where can be: --debug, --help or --man. Signed-off-by: Federico Vaga Signed-off-by: Jonathan Corbet

doc:doc-guide: fix a typo and an error

2018-06-26T15:07:25+00:00

Fix a typo in sphinx.rst and a minor error in parse-header.rst Signed-off-by: Federico Vaga Signed-off-by: Jonathan Corbet

MAINTAINERS & files: Canonize the e-mails I use at files

2018-05-04T10:21:06+00:00

From now on, I'll start using my @kernel.org as my development e-mail. As such, let's remove the entries that point to the old mchehab@s-opensource.com at MAINTAINERS file. For the files written with a copyright with mchehab@s-opensource, let's keep Samsung on their names, using mchehab+samsung@kernel.org, in order to keep pointing to my employer, with sponsors the work. For the files written before I join Samsung (on July, 4 2013), let's just use mchehab@kernel.org. For bug reports, we can simply point to just kernel.org, as this will reach my mchehab+samsung inbox anyway. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Brian Warner Signed-off-by: Mauro Carvalho Chehab

docs-rst: parse-headers.pl: cleanup the documentation

2016-12-01T00:08:09+00:00

Keeping both rst and in-file documentation in sync can be harsh. So, simplify the script's internal documntation to a bare minimum, and add a mention to the ReST file with its full documentation. This way, a quick help is still available at the command line, while the complete one is maintained at the ReST format. As we won't be using pad2rst anymore, do a cleanup at the ReST file. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

parse-headers.rst: add an introduction to the man page

2016-11-19T17:22:15+00:00

The pod2rst tool generated a man page for parse-headers.pl script, but it is better to put it into some context. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet

parse-headers.pl: add documentation for this script

2016-11-19T17:22:08+00:00

Provide a man page for parse-headers.pl, describing how to use it. The documentation on ReST format was generated via pod2rst: http://search.cpan.org/~dowens/Pod-POM-View-Restructured-0.02/bin/pod2rst Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet