From: Jonathan Corbet <corbet@lwn.net>
To: Matthew Wilcox <willy@infradead.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Christoph Hellwig <hch@infradead.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org, Ingo Molnar <mingo@redhat.com>,
Peter Zijlstra <peterz@infradead.org>
Subject: Re: [RFC PATCH 1/2] scripts/kernel-doc: Auto-detect common code-blocks
Date: Thu, 10 May 2018 10:51:05 -0600 [thread overview]
Message-ID: <20180510105105.5cb0d54f@lwn.net> (raw)
In-Reply-To: <20180510163456.GC30442@bombadil.infradead.org>
On Thu, 10 May 2018 09:34:56 -0700
Matthew Wilcox <willy@infradead.org> wrote:
> I think this is a bit fragile. Why not just search for ':\n'? Is
> there ever a case where we want to write:
>
> /**
> * foo is a bar:
> * wibble
> */
> and have wibble not be a code-block?
Yeah, we might want to write something like:
- Leading off a bulleted list
1) or a numbered list
for example. That's why I was thinking of looking for explicit markers
for such lists.
It'll take some playing around with to have a hope of getting right,
methinks.
jon
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
WARNING: multiple messages have this Message-ID (diff)
From: Jonathan Corbet <corbet@lwn.net>
To: Matthew Wilcox <willy@infradead.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Christoph Hellwig <hch@infradead.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org, Ingo Molnar <mingo@redhat.com>,
Peter Zijlstra <peterz@infradead.org>
Subject: Re: [RFC PATCH 1/2] scripts/kernel-doc: Auto-detect common code-blocks
Date: Thu, 10 May 2018 10:51:05 -0600 [thread overview]
Message-ID: <20180510105105.5cb0d54f@lwn.net> (raw)
In-Reply-To: <20180510163456.GC30442@bombadil.infradead.org>
On Thu, 10 May 2018 09:34:56 -0700
Matthew Wilcox <willy@infradead.org> wrote:
> I think this is a bit fragile. Why not just search for ':\n'? Is
> there ever a case where we want to write:
>
> /**
> * foo is a bar:
> * wibble
> */
> and have wibble not be a code-block?
Yeah, we might want to write something like:
- Leading off a bulleted list
1) or a numbered list
for example. That's why I was thinking of looking for explicit markers
for such lists.
It'll take some playing around with to have a hope of getting right,
methinks.
jon
next prev parent reply other threads:[~2018-05-10 16:51 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-10 14:38 [RFC PATCH 1/2] scripts/kernel-doc: Auto-detect common code-blocks Mauro Carvalho Chehab
2018-05-10 14:38 ` Mauro Carvalho Chehab
2018-05-10 14:38 ` [RFC PATCH 2/2] wait: add a keyword to indicate a diagram code block on a kernel-doc Mauro Carvalho Chehab
2018-05-10 14:38 ` Mauro Carvalho Chehab
2018-05-10 16:33 ` Randy Dunlap
2018-05-10 16:33 ` Randy Dunlap
2018-05-10 16:34 ` [RFC PATCH 1/2] scripts/kernel-doc: Auto-detect common code-blocks Matthew Wilcox
2018-05-10 16:34 ` Matthew Wilcox
2018-05-10 16:51 ` Jonathan Corbet [this message]
2018-05-10 16:51 ` Jonathan Corbet
2018-05-14 11:03 ` Jani Nikula
2018-05-14 11:03 ` Jani Nikula
2018-07-05 15:40 ` Daniel Vetter
2018-07-05 15:40 ` Daniel Vetter
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=20180510105105.5cb0d54f@lwn.net \
--to=corbet@lwn.net \
--cc=hch@infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mchehab@infradead.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--cc=willy@infradead.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.