All of lore.kernel.org
 help / color / mirror / Atom feed
From: Paolo Bonzini <pbonzini@redhat.com>
To: qemu-devel@nongnu.org
Subject: [PATCH 15/29] Revert "kernel-doc: Use c:struct for Sphinx 3.0 and later"
Date: Tue, 17 Nov 2020 17:52:58 +0100	[thread overview]
Message-ID: <20201117165312.118257-16-pbonzini@redhat.com> (raw)
In-Reply-To: <20201117165312.118257-1-pbonzini@redhat.com>

This reverts commit 152d1967f650f67b7ece3a5dda77d48069d72647.
We will replace the commit with the fix from Linux.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 docs/sphinx/kerneldoc.py |  1 -
 scripts/kernel-doc       | 16 +---------------
 2 files changed, 1 insertion(+), 16 deletions(-)

diff --git a/docs/sphinx/kerneldoc.py b/docs/sphinx/kerneldoc.py
index 3ac277d162..0df6a0814d 100644
--- a/docs/sphinx/kerneldoc.py
+++ b/docs/sphinx/kerneldoc.py
@@ -99,7 +99,6 @@ class KernelDocDirective(Directive):
                 env.note_dependency(os.path.abspath(f))
                 cmd += ['-export-file', f]
 
-        cmd += ['-sphinx-version', sphinx.__version__]
         cmd += [filename]
 
         try:
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index cb603532ed..60f75cd176 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -71,8 +71,6 @@ Output selection (mutually exclusive):
 			DOC: sections. May be specified multiple times.
 
 Output selection modifiers:
-  -sphinx-version VER   Generate rST syntax for the specified Sphinx version.
-                        Only works with reStructuredTextFormat.
   -no-doc-sections	Do not output DOC: sections.
   -enable-lineno        Enable output of #define LINENO lines. Only works with
                         reStructuredText format.
@@ -294,7 +292,6 @@ use constant {
 };
 my $output_selection = OUTPUT_ALL;
 my $show_not_found = 0;	# No longer used
-my $sphinx_version = "0.0"; # if not specified, assume old
 
 my @export_file_list;
 
@@ -460,8 +457,6 @@ while ($ARGV[0] =~ m/^--?(.*)/) {
 	    $enable_lineno = 1;
     } elsif ($cmd eq 'show-not-found') {
 	$show_not_found = 1;  # A no-op but don't fail
-    } elsif ($cmd eq 'sphinx-version') {
-        $sphinx_version = shift @ARGV;
     } else {
 	# Unknown argument
         usage();
@@ -989,16 +984,7 @@ sub output_struct_rst(%) {
     my $oldprefix = $lineprefix;
     my $name = $args{'type'} . " " . $args{'struct'};
 
-    # Sphinx 3.0 and up will emit warnings for "c:type:: struct Foo".
-    # It wants to see "c:struct:: Foo" (and will add the word 'struct' in
-    # the rendered output).
-    if ((split(/\./, $sphinx_version))[0] >= 3) {
-        my $sname = $name;
-        $sname =~ s/^struct //;
-        print "\n\n.. c:struct:: " . $sname . "\n\n";
-    } else {
-        print "\n\n.. c:type:: " . $name . "\n\n";
-    }
+    print "\n\n.. c:type:: " . $name . "\n\n";
     print_lineno($declaration_start_line);
     $lineprefix = "   ";
     output_highlight_rst($args{'purpose'});
-- 
2.28.0




  parent reply	other threads:[~2020-11-17 17:03 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-17 16:52 [RFC PATCH 00/29] kernel-doc: update from Linux 5.10 Paolo Bonzini
2020-11-17 16:52 ` [PATCH 01/29] kernel-doc: fix processing nested structs with attributes Paolo Bonzini
2020-11-17 16:52 ` [PATCH 02/29] kernel-doc: add support for ____cacheline_aligned_in_smp attribute Paolo Bonzini
2020-11-17 16:52 ` [PATCH 03/29] scripts/kernel-doc: Add support for named variable macro arguments Paolo Bonzini
2020-11-17 16:52 ` [PATCH 04/29] scripts: kernel-doc: proper handle @foo->bar() Paolo Bonzini
2020-11-17 16:52 ` [PATCH 05/29] scripts: kernel-doc: accept negation like !@var Paolo Bonzini
2020-11-17 16:52 ` [PATCH 06/29] scripts: kernel-doc: accept blank lines on parameter description Paolo Bonzini
2020-11-17 16:52 ` [PATCH 07/29] Replace HTTP links with HTTPS ones: documentation Paolo Bonzini
2020-11-17 16:52 ` [PATCH 08/29] scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK Paolo Bonzini
2020-11-17 16:52 ` [PATCH 09/29] scripts/kernel-doc: handle function pointer prototypes Paolo Bonzini
2020-11-17 16:52 ` [PATCH 10/29] scripts/kernel-doc: optionally treat warnings as errors Paolo Bonzini
2020-11-17 16:52 ` [PATCH 11/29] kernel-doc: include line numbers for function prototypes Paolo Bonzini
2020-11-17 16:52 ` [PATCH 12/29] kernel-doc: add support for ____cacheline_aligned attribute Paolo Bonzini
2020-11-17 16:52 ` [PATCH 13/29] scripts: kernel-doc: add support for typedef enum Paolo Bonzini
2020-11-17 16:52 ` [PATCH 14/29] Revert "scripts/kerneldoc: For Sphinx 3 use c:macro for macros with arguments" Paolo Bonzini
2020-11-17 16:52 ` Paolo Bonzini [this message]
2020-11-17 16:52 ` [PATCH 16/29] scripts: kernel-doc: make it more compatible with Sphinx 3.x Paolo Bonzini
2020-11-17 16:53 ` [PATCH 17/29] scripts: kernel-doc: use a less pedantic markup for funcs on " Paolo Bonzini
2020-11-17 16:53 ` [PATCH 18/29] scripts: kernel-doc: fix troubles with line counts Paolo Bonzini
2020-11-17 16:53 ` [PATCH 19/29] scripts: kernel-doc: reimplement -nofunction argument Paolo Bonzini
2020-11-17 16:53 ` [PATCH 20/29] scripts: kernel-doc: fix typedef identification Paolo Bonzini
2020-11-17 16:53 ` [PATCH 21/29] scripts: kernel-doc: don't mangle with parameter list Paolo Bonzini
2020-11-17 16:53 ` [PATCH 22/29] scripts: kernel-doc: allow passing desired Sphinx C domain dialect Paolo Bonzini
2020-11-17 16:53 ` [PATCH 23/29] scripts: kernel-doc: fix line number handling Paolo Bonzini
2020-11-17 16:53 ` [PATCH 24/29] scripts: kernel-doc: try to use c:function if possible Paolo Bonzini
2020-11-17 16:53 ` [PATCH 25/29] Revert "kernel-doc: Handle function typedefs without asterisks" Paolo Bonzini
2020-11-17 16:53 ` [PATCH 26/29] Revert "kernel-doc: Handle function typedefs that return pointers" Paolo Bonzini
2020-11-17 16:53 ` [PATCH 27/29] scripts: kernel-doc: fix typedef parsing Paolo Bonzini
2020-11-17 16:53 ` [PATCH 28/29] scripts: kernel-doc: split typedef complex regex Paolo Bonzini
2020-11-17 16:53 ` [PATCH 29/29] scripts: kernel-doc: use :c:union when needed Paolo Bonzini
2020-11-30 11:28 ` [RFC PATCH 00/29] kernel-doc: update from Linux 5.10 Peter Maydell
2020-11-30 11:59   ` Paolo Bonzini

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201117165312.118257-16-pbonzini@redhat.com \
    --to=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.