From: Mauro Carvalho Chehab <mchehab@kernel.org> To: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net>, ksummit <ksummit-discuss@lists.linuxfoundation.org>, ksummit@lists.linux.dev Subject: Re: [Ksummit-discuss] [TECH TOPIC] What kernel documentation could be Date: Sat, 18 Jun 2022 12:16:06 +0100 [thread overview] Message-ID: <20220618121606.755e40df@sal.lan> (raw) In-Reply-To: <CANiq72kafybxPbS13g+heYMX=Ggmw_8MqYj41uJ0Ek=3HP7-eA@mail.gmail.com> Em Sat, 18 Jun 2022 13:03:38 +0200 Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> escreveu: > On Sat, Jun 18, 2022 at 10:24 AM Mauro Carvalho Chehab > <mchehab@kernel.org> wrote: > > > > Life would be a lot easier on this side if rustdoc could > > support ReST. > > Not sure what you mean by this. Do you mean writing ReST for Rust > documentation? For the files inside `Documentation/rust/`, we already > use ReST [*] like the rest. For the source code docs (the ones handled > by rustdoc), it outputs HTML. Or do you mean using rustdoc to generate > `Doc/`s or similar? I meant that rustdoc could generate ReST output, being included inside the Kernel documentation on a way similar to kerneldoc. This would integrate better with our building system, which can produce output docs on 3 different formats (html, epub and pdf). Regards, Mauro > > [*] Though it would be nice to be able to use Markdown (but that is a > different topic). > > Cheers, > Miguel
WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab@kernel.org> Subject: [Ksummit-discuss] [TECH TOPIC] What kernel documentation could be Date: Sat, 18 Jun 2022 12:16:06 +0100 [thread overview] Message-ID: <20220618121606.755e40df@sal.lan> (raw) Message-ID: <20220618111606.SQ5WHpKOp3u6I3SeI90Y9IdG_KDIMjAKDlQDfPpWwyA@z> (raw) In-Reply-To: <CANiq72kafybxPbS13g+heYMX=Ggmw_8MqYj41uJ0Ek=3HP7-eA@mail.gmail.com> Em Sat, 18 Jun 2022 13:03:38 +0200 Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> escreveu: > On Sat, Jun 18, 2022 at 10:24 AM Mauro Carvalho Chehab > <mchehab@kernel.org> wrote: > > > > Life would be a lot easier on this side if rustdoc could > > support ReST. > > Not sure what you mean by this. Do you mean writing ReST for Rust > documentation? For the files inside `Documentation/rust/`, we already > use ReST [*] like the rest. For the source code docs (the ones handled > by rustdoc), it outputs HTML. Or do you mean using rustdoc to generate > `Doc/`s or similar? I meant that rustdoc could generate ReST output, being included inside the Kernel documentation on a way similar to kerneldoc. This would integrate better with our building system, which can produce output docs on 3 different formats (html, epub and pdf). Regards, Mauro > > [*] Though it would be nice to be able to use Markdown (but that is a > different topic). > > Cheers, > Miguel
next prev parent reply other threads:[~2022-06-18 11:16 UTC|newest] Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-06-17 20:57 [TECH TOPIC] What kernel documentation could be Jonathan Corbet 2022-06-17 20:57 ` [Ksummit-discuss] " Jonathan Corbet 2022-06-17 21:48 ` Laurent Pinchart 2022-06-17 21:48 ` Laurent Pinchart 2022-06-27 15:18 ` Jonathan Corbet 2022-06-18 8:24 ` Mauro Carvalho Chehab 2022-06-18 8:24 ` Mauro Carvalho Chehab 2022-06-18 11:03 ` Miguel Ojeda 2022-06-18 11:16 ` Mauro Carvalho Chehab [this message] 2022-06-18 11:16 ` Mauro Carvalho Chehab 2022-06-18 14:37 ` Miguel Ojeda 2022-06-23 9:18 ` Jani Nikula 2022-06-23 9:57 ` Mauro Carvalho Chehab 2022-06-23 10:30 ` Jani Nikula 2022-06-23 13:40 ` Jonathan Corbet 2022-06-24 7:33 ` Mauro Carvalho Chehab 2022-06-24 16:37 ` Markus Heiser 2022-06-27 15:27 ` Jonathan Corbet 2022-06-27 15:31 ` Christoph Hellwig 2022-06-28 7:43 ` Mauro Carvalho Chehab 2022-06-28 7:57 ` Geert Uytterhoeven 2022-06-28 11:01 ` Mauro Carvalho Chehab 2022-07-02 12:43 ` Stephen Rothwell 2022-06-24 22:57 ` Jonathan Corbet 2022-06-25 9:10 ` Mauro Carvalho Chehab 2022-06-25 14:00 ` Jonathan Corbet 2022-06-25 18:11 ` Linus Torvalds 2022-06-26 7:55 ` Mauro Carvalho Chehab 2022-06-26 9:26 ` Mauro Carvalho Chehab 2022-06-26 9:53 ` Mauro Carvalho Chehab 2022-06-27 15:28 ` Liam Howlett 2022-06-27 15:54 ` Christian Brauner 2022-06-27 16:27 ` Mark Brown 2022-06-28 10:53 ` Mauro Carvalho Chehab 2022-06-28 16:13 ` Luck, Tony 2022-06-27 15:34 ` Jonathan Corbet 2022-06-27 17:07 ` Linus Torvalds 2022-07-02 10:52 ` Mauro Carvalho Chehab 2022-06-25 17:43 ` Steven Rostedt 2022-06-25 17:48 ` Laurent Pinchart
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=20220618121606.755e40df@sal.lan \ --to=mchehab@kernel.org \ --cc=corbet@lwn.net \ --cc=ksummit-discuss@lists.linuxfoundation.org \ --cc=ksummit@lists.linux.dev \ --cc=miguel.ojeda.sandonis@gmail.com \ /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: linkBe 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 read-only IMAP folder(s) and NNTP newsgroup(s).