linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Chris Down <chris@chrisdown.name>
To: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, Petr Mladek <pmladek@suse.com>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: Re: linux-next: build warning after merge of the printk tree
Date: Tue, 20 Jul 2021 13:22:28 +0100	[thread overview]
Message-ID: <YPbABBSTkN+xNY0w@chrisdown.name> (raw)
In-Reply-To: <YPa/D8tSyk7dw1/l@chrisdown.name>

[-- Attachment #1: Type: text/plain, Size: 1010 bytes --]

Chris Down writes:
>+Cc: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org

Well, let's actually Cc them this time...

>Stephen Rothwell writes:
>>After merging the printk tree, today's linux-next build (htmldocs)
>>produced this warning:
>>
>>kernel/printk/printk.c:1: warning: 'printk' not found
>>
>>Introduced by commit
>>
>> 337015573718 ("printk: Userspace format indexing support")
>>
>>I presume that "printk" is referred to elsewhere in the documentation
>>as being in this file.
>
>Hmm, this is an interesting one, because I think we still generally 
>just want to refer to the API as being `printk()`. Changing it all 
>over the place seems wrong. As you'd imagine, there are quite a few 
>references to this name, so it requires a lot of noise all over the 
>docs and inline comments.
>
>Jonathan and other docs folks, how can one tell Sphinx that when it 
>sees printk() it's referring to a function-like macro, or otherwise 
>squelch this reasonably? :-)



[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 963 bytes --]

       reply	other threads:[~2021-07-20 12:23 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20210720162423.75f61ce0@canb.auug.org.au>
     [not found] ` <YPa/D8tSyk7dw1/l@chrisdown.name>
2021-07-20 12:22   ` Chris Down [this message]
2021-07-23 11:09     ` [PATCH] printk/documentation: Update printk()/_printk() documentation Petr Mladek
2021-07-23 11:24       ` Petr Mladek
2021-07-25 21:16     ` linux-next: build warning after merge of the printk tree Jonathan Corbet
2021-07-26 12:28       ` Petr Mladek
2021-07-26 13:07       ` Chris Down

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=YPbABBSTkN+xNY0w@chrisdown.name \
    --to=chris@chrisdown.name \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=pmladek@suse.com \
    --cc=sfr@canb.auug.org.au \
    /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).