diff options
| author | Ben Hutchings <ben@decadent.org.uk> | 2015-09-01 23:48:49 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2015-09-13 14:38:50 -0600 |
| commit | 68f86662380c343317325c024d6a35221f1908ac (patch) | |
| tree | c361decb58dded445a6ce5b4a7ca8df26dcd6a1d /scripts | |
| parent | df5f0b6efb20be669ad356eba675706d4cda2d0b (diff) | |
| download | linux-68f86662380c343317325c024d6a35221f1908ac.tar.gz linux-68f86662380c343317325c024d6a35221f1908ac.tar.xz | |
Documentation: Avoid creating man pages in source tree
Currently kernel-doc generates a dummy DocBook file when asked to
convert a C source file with no structured comments. For an
out-of-tree build (objtree != srctree), the title of the output file
is the absolute path name of the C source file, which later results
in a manual page being created alongside the C source file.
Change the title to be a relative path.
Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts')
| -rwxr-xr-x | scripts/kernel-doc | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 532d8cd2543f..61b4aa86fcdf 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -2391,12 +2391,13 @@ sub process_file($) { my $descr; my $in_purpose = 0; my $initial_section_counter = $section_counter; + my ($orig_file) = @_; if (defined($ENV{'SRCTREE'})) { - $file = "$ENV{'SRCTREE'}" . "/" . "@_"; + $file = "$ENV{'SRCTREE'}" . "/" . $orig_file; } else { - $file = "@_"; + $file = $orig_file; } if (defined($source_map{$file})) { $file = $source_map{$file}; @@ -2640,7 +2641,7 @@ sub process_file($) { print "<refentry>\n"; print " <refnamediv>\n"; print " <refname>\n"; - print " ${file}\n"; + print " ${orig_file}\n"; print " </refname>\n"; print " <refpurpose>\n"; print " Document generation inconsistency\n"; @@ -2654,7 +2655,7 @@ sub process_file($) { print " <para>\n"; print " The template for this document tried to insert\n"; print " the structured comment from the file\n"; - print " <filename>${file}</filename> at this point,\n"; + print " <filename>${orig_file}</filename> at this point,\n"; print " but none was found.\n"; print " This dummy section is inserted to allow\n"; print " generation to continue.\n"; |