Commit dd803b04 authored by Tomasz Warniełło's avatar Tomasz Warniełło Committed by Jonathan Corbet
Browse files

scripts: kernel-doc: Translate the "Output format selection modifier" subsection of OPTIONS 



Aim: unified POD, user more happy

This section is renamed to "Output format modifiers" to make it simple.

To make it even more simple, a subsection is added:
"reStructuredText only".

Other notes:
- paragraphing correction
- article correction

Signed-off-by: default avatarTomasz Warniełło <tomasz.warniello@gmail.com>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Disliked-by: default avatarAkira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/20220218181628.1411551-6-tomasz.warniello@gmail.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 2875f787

scripts/kernel-doc

+15 −7
Original line number Diff line number Diff line
@@ -83,13 +83,6 @@ sub usage { 
    my $message = <<"EOF";

Usage: $0 [OPTION ...] FILE ...



Output format selection modifier (affects only ReST output):



  -sphinx-version	Use the ReST C domain dialect compatible with an

			specific Sphinx Version.

			If not specified, kernel-doc will auto-detect using

			the sphinx-build version found on PATH.



Output selection (mutually exclusive):

  -export		Only output documentation for symbols that have been

			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
@@ -2583,4 +2576,19 @@ Do not output documentation, only warnings. 


=back



=head2 Output format modifiers



=head3 reStructuredText only



=over 8



=item -sphinx-version VERSION



Use the ReST C domain dialect compatible with a specific Sphinx Version.



If not specified, kernel-doc will auto-detect using the sphinx-build version

found on PATH.



=back



=cut