public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@xenotime.net>
To: Dan Luedtke <mail@danrl.de>
Cc: linux-kernel@vger.kernel.org
Subject: Re: [PATCH] scripts/kernel-doc: added support for html5
Date: Wed, 25 Jul 2012 11:14:43 -0700	[thread overview]
Message-ID: <50103793.8000600@xenotime.net> (raw)
In-Reply-To: <1343223488-1332-1-git-send-email-mail@danrl.de>

On 07/25/2012 06:38 AM, Dan Luedtke wrote:

> New output option html5 writes validating HTML5 and adds

> CSS classes ready to be selected by third-party stylesheets.
> 
> Signed-off-by: Dan Luedtke <mail@danrl.de>
> ---
>  scripts/kernel-doc |  255 ++++++++++++++++++++++++++++++++++++++++++++++++++--
>  1 file changed, 249 insertions(+), 6 deletions(-)
> 
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 9b0c0b8..f85b278 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -182,6 +189,14 @@ my $local_lt = "\\\\\\\\lt:";
>  my $local_gt = "\\\\\\\\gt:";
>  my $blankline_html = $local_lt . "p" . $local_gt;	# was "<p>"
>  
> +# modern html


Just say "html5" or "html version 5".
A few years from now it won't be modern.

> +my %highlights_html5 = ( $type_constant, "<span class=\"const\">\$1</span>",
> +			$type_func, "<span class=\"func\">\$1</span>",
> +			$type_struct_xml, "<span class=\"struct\">\$1</span>",
> +			$type_env, "<span class=\"env\">\$1</span>",
> +			$type_param, "<span class=\"param\">\$1</span>" );
> +my $blankline_html5 = $local_lt . "br /" . $local_gt;
> +
>  # XML, docbook format
>  my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
>  			$type_constant, "<constant>\$1</constant>",



Have you tested typedef, enum, DOC:, etc.?
The example web page that you posted does not use that AFAICT.


Otherwise it looks OK to me.

Thanks,
-- 
~Randy

  parent reply	other threads:[~2012-07-25 18:15 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-25 13:38 [PATCH] scripts/kernel-doc: added support for html5 Dan Luedtke
2012-07-25 13:50 ` FYI: Example [Re: [PATCH] scripts/kernel-doc: added support for html5] Dan Luedtke
2012-07-25 18:14 ` Randy Dunlap [this message]
2012-07-26  6:52   ` [PATCH 1/3] scripts/kernel-doc: added support for html5 Dan Luedtke
2012-07-26  6:52     ` [PATCH 2/3] scripts/kernel-doc: modern html -> html version 5 Dan Luedtke
2012-07-26  6:52     ` [PATCH 3/3] scripts/kernel-doc: added ids to articles for reference Dan Luedtke
2012-07-26  6:53   ` [PATCH] scripts/kernel-doc: added support for html5 Dan Luedtke
2012-07-26 15:13     ` Randy Dunlap

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=50103793.8000600@xenotime.net \
    --to=rdunlap@xenotime.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mail@danrl.de \
    /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