From: "Marc-André Lureau" <marcandre.lureau@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, armbru@redhat.com,
"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: [Qemu-devel] [PATCH v8 13/21] texi2pod: learn quotation, deftp and deftypefn
Date: Fri, 13 Jan 2017 15:41:27 +0100 [thread overview]
Message-ID: <20170113144135.5150-14-marcandre.lureau@redhat.com> (raw)
In-Reply-To: <20170113144135.5150-1-marcandre.lureau@redhat.com>
Learn a few more markups used for API documentation.
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
scripts/texi2pod.pl | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 51 insertions(+), 3 deletions(-)
diff --git a/scripts/texi2pod.pl b/scripts/texi2pod.pl
index 8767662d30..6e8fec41a1 100755
--- a/scripts/texi2pod.pl
+++ b/scripts/texi2pod.pl
@@ -37,6 +37,7 @@ $inf = "";
$ibase = "";
@ipath = ();
$encoding = undef;
+@args = ();
while ($_ = shift) {
if (/^-D(.*)$/) {
@@ -162,7 +163,8 @@ while(<$inf>) {
if ($ended =~ /^(?:ifset|ifclear|ignore|menu|iftex)$/) {
$skipping = pop @skstack;
next;
- } elsif ($ended =~ /^(?:example|smallexample|display)$/) {
+ } elsif ($ended =~ /^(?:example|smallexample|display
+ |quotation|deftp|deftypefn)$/x) {
$shift = "";
$_ = ""; # need a paragraph break
} elsif ($ended =~ /^(?:itemize|enumerate|[fv]?table)$/) {
@@ -303,6 +305,7 @@ while(<$inf>) {
$ic =~ s/\@(?:code|kbd)/C/;
$ic =~ s/\@(?:dfn|var|emph|cite|i)/I/;
$ic =~ s/\@(?:file)/F/;
+ $ic =~ s/\@(?:asis)//;
$_ = "\n=over 4\n";
};
@@ -323,10 +326,54 @@ while(<$inf>) {
$_ = "\n=item ".join (" : ", @columns)."\n";
};
+ /^\@(quotation)\s*(.+)?$/ and do {
+ push @endwstack, $endw;
+ $endw = $1;
+ $_ = "\n$2:"
+ };
+
+ /^{(.*)}$|^(.*)$/ and $#args > 0 and do {
+ $kind = $args[0];
+ $arguments = $1 // "";
+ if ($endw eq "deftypefn") {
+ $ret = $args[1];
+ $fname = "B<$args[2]>";
+ $_ = $ret ? "$ret " : "";
+ $_ .= "$fname $arguments ($kind)";
+ } else {
+ $_ = "B<$args[1]> ($kind)\n\n$arguments";
+ }
+ @args = ();
+ };
+
+ /^\@(deftp)\s*(.+)?$/ and do {
+ push @endwstack, $endw;
+ $endw = $1;
+ $arg = $2;
+ $arg =~ s/{([^}]*)}/$1/g;
+ $arg =~ s/\@$//;
+ @args = split (/ /, $arg);
+ $_ = "";
+ };
+
+ /^\@(deftypefn)\s*(.+)?$/ and do {
+ push @endwstack, $endw;
+ $endw = $1;
+ $arg = $2;
+ $arg =~ s/{([^}]*)}/$1/g;
+ $arg =~ s/\@$//;
+ @args = split (/ /, $arg);
+ $_ = "";
+ };
+
/^\@itemx?\s*(.+)?$/ and do {
if (defined $1) {
- # Entity escapes prevent munging by the <> processing below.
- $_ = "\n=item $ic\<$1\>\n";
+ if ($ic eq "") {
+ $_ = "\n=item $1\n";
+ } else {
+ # Entity escapes prevent munging by the <> processing below.
+ $_ = "\n=item $ic\<$1\>\n";
+ }
} else {
$_ = "\n=item $ic\n";
$ic =~ y/A-Ya-y/B-Zb-z/;
@@ -388,6 +435,7 @@ sub postprocess
s/\@sc\{([^\}]*)\}/\U$1/g;
s/\@file\{([^\}]*)\}/F<$1>/g;
s/\@w\{([^\}]*)\}/S<$1>/g;
+ s/\@t\{([^\}]*)\}/$1/g;
s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;
# keep references of the form @ref{...}, print them bold
--
2.11.0
next prev parent reply other threads:[~2017-01-13 14:42 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-13 14:41 [Qemu-devel] [PATCH v8 00/21] qapi doc generation (whole version, squashed) Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 01/21] qapi: replace 'o' for list items Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 02/21] qapi: move QKeyCode doc body at the top Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 03/21] qapi: make TODOs named-sections Marc-André Lureau
2017-01-13 16:03 ` Markus Armbruster
2017-01-13 16:07 ` Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 04/21] qapi: improve device_add schema Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 05/21] qapi: improve TransactionAction doc Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 06/21] qga/schema: improve guest-set-vcpus Returns: section Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 07/21] qapi: avoid interleaving sections and parameters Marc-André Lureau
2017-01-13 16:14 ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 08/21] qapi: move experimental note down Marc-André Lureau
2017-01-13 16:14 ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 09/21] qapi: add some sections in docs Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 10/21] docs: add master qapi texi files Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 11/21] qapi: rework qapi Exception Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 12/21] qapi.py: fix line break before binary operator pep8 Marc-André Lureau
2017-01-13 16:15 ` Markus Armbruster
2017-01-13 16:26 ` Marc-André Lureau
2017-01-13 16:46 ` Markus Armbruster
2017-01-13 14:41 ` Marc-André Lureau [this message]
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 14/21] (SQUASHED) move doc to schema Marc-André Lureau
2017-05-22 21:31 ` Eric Blake
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 15/21] qapi: add qapi2texi script Marc-André Lureau
2017-01-16 9:37 ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 16/21] docs: add qemu logo to pdf Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 17/21] build-sys: use --no-split for info Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 18/21] build-sys: remove dvi doc generation Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 19/21] build-sys: use a generic TEXI2MAN rule Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 20/21] build-sys: add txt documentation rules Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 21/21] build-sys: add qapi doc generation targets Marc-André Lureau
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=20170113144135.5150-14-marcandre.lureau@redhat.com \
--to=marcandre.lureau@redhat.com \
--cc=armbru@redhat.com \
--cc=eblake@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).