* struct foo - bar
* @*: This member is private.
*/
Would generate the documentation for the member with the catch-all
documentation, which might be a generally useful feature, and would be
easy on the source code side. This could be combined with the PRIVATE
designation above, practically leading to the same result as the first
option but with more flexibility.
BR,
Jani.
--
Jani Nikula, Intel Open Source Graphics Center
20+
> subsystems. Between mailing lists and maintainers that's usually
> already 60+ recipients. If you now add a another 2-3 maintainers
> we're just going to hit limits in mail servers.
I thought this was about adding people who have commented on previous
versions to Cc. That&
.
rst basically allows any order of the heading underlines, and their
relative hierarchy is determined by how they show up in each document,
it's not specified by rst. However, it would be much easier for everyone
if all the kernel documents followed the same style.
BR,
Jani.
--
Jani Nikula, Intel
ly updated bullet
numbering. Either make them bulleted lists with "*" or autonumbered
lists with "#.". See [1]. This should be a separate change.
BR,
Jani.
[1]
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks
--
Jani Nikula, Intel
On Thu, 29 Feb 2024, Lukas Bulwahn wrote:
> from Jani Nikula:
> - turn categories into subheadings
> - use common heading adornment
> - change to bullet or autonumbered lists
> - propose those changes as separate additional patches
I was hoping these cleanups would'
matches my recollection of how it works. Especially the
meaning of the first 8 threw me off way back when. And looks like I've
replied to that effect for v1.
FWIW,
Reviewed-by: Jani Nikula
but I'm sure there are more pedantic reviewers for all the minor
details.
>
> Acked-by: Gustavo A
email headers on the mail
> archives,
> +such as https://lore.kernel.org.
> +
> Co-developed-by: states that the patch was co-created by multiple developers;
> it is used to give attribution to co-authors (in addition to the author
> attributed by the From: tag) when several people work on a single patch.
> Since
--
Jani Nikula, Intel
On Tue, 23 Apr 2024, Andy Shevchenko wrote:
> On Tue, Apr 23, 2024 at 05:30:49PM +0300, Jani Nikula wrote:
>> The Cc's on the mailing list archive are harder to dig up, and do not
>> accurately reflect the same information.
>
> How comes? These Cc: are 1:1 mapped to the
On Tue, 23 Apr 2024, Andy Shevchenko wrote:
> On Tue, Apr 23, 2024 at 07:37:34PM +0300, Jani Nikula wrote:
>> On Tue, 23 Apr 2024, Andy Shevchenko
>> wrote:
>> > On Tue, Apr 23, 2024 at 05:30:49PM +0300, Jani Nikula wrote:
>> >> The Cc's on the mailing
r.
BR,
Jani.
> +
> + Link: https://patch.msgid.link/patch-source-msgid@here
>
> Please do not use combined tags, e.g. ``Reported-and-tested-by``, as
> they just complicate automated extraction of tags.
--
Jani Nikula, Intel
&parsed_total_len, data_types,
> + num_data_types);
> + switch (ret) {
> + case 0:
> + /*
> + * tlv_parse_hdr() already checked that
> + * parsed_total_len <= data_len.
> + */
> + data_ptr += parsed_total_len;
> + data_len -= parsed_total_len;
> + continue;
> + case 1:
> + break;
> + default:
> + goto out;
> + }
> +
> + ret = tlv_parse_data(data_callback, data_callback_data,
> + parsed_num_entries, data_ptr,
> + parsed_total_len, fields, num_fields);
> + if (ret < 0)
> + goto out;
> +
> + data_ptr += parsed_total_len;
> + data_len -= parsed_total_len;
> + }
> +out:
> + pr_debug("End of parsing data blob, ret: %d\n", ret);
> + return ret;
> +}
> diff --git a/lib/tlv_parser.h b/lib/tlv_parser.h
> new file mode 100644
> index ..8fa8127bd13e
> --- /dev/null
> +++ b/lib/tlv_parser.h
> @@ -0,0 +1,17 @@
> +/* SPDX-License-Identifier: GPL-2.0 */
> +/*
> + * Copyright (C) 2023-2024 Huawei Technologies Duesseldorf GmbH
> + *
> + * Author: Roberto Sassu
> + *
> + * Header file of TLV parser.
> + */
> +
> +#ifndef _LIB_TLV_PARSER_H
> +#define _LIB_TLV_PARSER_H
> +
> +#include
> +#include
> +#include
> +
> +#endif /* _LIB_TLV_PARSER_H */
--
Jani Nikula, Intel
On Fri, 06 Sep 2024, Roberto Sassu wrote:
> On Thu, 2024-09-05 at 20:30 +0300, Jani Nikula wrote:
>> On Thu, 05 Sep 2024, Roberto Sassu wrote:
>> > From: Roberto Sassu
>> >
>> > Add a parser of a ge
On Fri, 06 Sep 2024, Roberto Sassu wrote:
> On Fri, 2024-09-06 at 11:06 +0300, Jani Nikula wrote:
>> On Fri, 06 Sep 2024, Roberto Sassu wrote:
>> > On Thu, 2024-09-05 at 20:30 +0300, Jani Nikula wrote:
>> > > On Thu, 05 Sep 2024, Roberto Sassu wrote
[x] = #x
static const char * const errorcodes[] = {
ERRORCODE(EPERM),
ERRORCODE(ENOENT),
...
};
Saves space, faster lookup, discovers at build time why EWOULDBLOCK
would always show up as EAGAIN in the logs. We don't have holes to speak
of in the error codes.
BR,
Jani.
--
Jani Nikula, Intel Open Source Graphics Center
On Mon, 26 Aug 2019, Jani Nikula wrote:
> On Sat, 24 Aug 2019, Andrew Morton wrote:
>>> --- a/lib/vsprintf.c
>>> +++ b/lib/vsprintf.c
>>> @@ -533,6 +533,192 @@ char *number(char *buf, char *end, unsigned long long
>>> num,
>>> return buf;
&g
ed up, we can just remove the feature again
>> next
>> year (or so).
>
> It looks like a lot of potentially useless work.
>
>
>> I dropped the example conversion, I think the idea should be clear now
>> even without an explicit example.
>
> Please, do the op
On Fri, 06 Sep 2019, Joe Perches wrote:
> Link:
> https://lore.kernel.org/lkml/CAHk-=wgoxnmsj8GEVFJSvTwdnWm8wVJthefNk2n6+4TC=20...@mail.gmail.com/
I thought Link: was for referencing the patch on the mailing list that
became the commit in git.
BR,
Jani.
--
Jani Nikula, Intel Open
+os.write(writer, jobs)
>>
>> You made writer nonblocking, so it seems plausible that we could leak some
>> slots here, no? Does writer really need to be nonblocking?
>
> Good point. I will fix this too.
>
>>
>> > +# If the jobserver was (impossibly) full or communication failed, use
>> > default.
>> > +if len(jobs) < 1:
>> > + print(default)
>> > +
>> > +# Report available slots (with a bump for our caller's reserveration).
>> > +print(len(jobs) + 1)
>>
>> The last question I have is...why is it that we have to do this complex
>> dance rather than just passing the "-j" option through directly to sphinx?
>> That comes down to the "confusion" mentioned at the top, I assume. It
>> would be good to understand that?
>
> There is no method I have found to discover the -j option's contents
> (intentionally so, it seems) from within make. :(
--
Jani Nikula, Intel Open Source Graphics Center
so notify the people that have git commit signatures.
> - X: Files and directories that are NOT maintained, same rules as F:
> -Files exclusions are tested before file matches.
> + X: *Excluded* files and directories that are NOT maintained, same
> +rules as F:. Files exclusions are tested before file matches.
> Can be useful for excluding a specific subdirectory, for instance:
> F: net/
> X: net/ipv6/
> matches all files in and below net excluding net/ipv6/
> - K: Keyword perl extended regex pattern to match content in a
> -patch or file. For instance:
> + K: *Content regex* (perl extended) pattern match in a patch or file.
> +For instance:
> K: of_get_profile
> matches patches or files that contain "of_get_profile"
> K: \b(printk|pr_(info|err))\b
> @@ -128,13 +130,12 @@ Descriptions of section entries:
> printk, pr_info or pr_err
> One regex pattern per line. Multiple K: lines acceptable.
>
> -Note: For the hard of thinking, this list is meant to remain in alphabetical
> -order. If you could add yourselves to it in alphabetical order that would be
> -so much easier [Ed]
> -
> -Maintainers List (try to look for most precise areas first)
> +Maintainers List
> +
>
> - ---
> +.. note:: When reading this list, please look for the most precise areas
> + first. When adding to this list, please keep the entries in
> + alphabetical order.
>
> 3C59X NETWORK DRIVER
> M: Steffen Klassert
> --
> 2.17.1
--
Jani Nikula, Intel Open Source Graphics Center
On Tue, 24 Sep 2019, Kees Cook wrote:
> On Tue, Sep 24, 2019 at 10:12:22AM +0300, Jani Nikula wrote:
>> On Mon, 23 Sep 2019, Kees Cook wrote:
>> > On Sun, Sep 22, 2019 at 02:03:31PM -0600, Jonathan Corbet wrote:
>> >> On Thu, 19 Sep 2019 14:44:3
None)}
>
> This requires online access while building the output. Anyway, as soon as
> I have some time to spare I will send a RFC with more explanation about
> (you will receive it in CC).
Please remember to call out the online access in the patch series. Such
a requirement is going to draw a lot of opposition.
BR,
Jani.
--
Jani Nikula, Intel Open Source Graphics Center
On Mon, 11 Mar 2019, Jonathan Corbet wrote:
> On Fri, 08 Mar 2019 14:17:47 +0200
> Jani Nikula wrote:
>
>> > >> To close such cross-books links we can use intersphinx [1] and map to
>> > e.g.
>> > >>
>> > >>intersphinx_map
are mounting.
>* @data: Arbitrary mount options, usually comes as an ASCII
>*string (see "Mount Options" section).
>*/
> struct dentry *(*mount) (struct file_system_type *fs_type, int flags,
>const char *dev_name, void *data);
> void (*kill_sb) (struct super_block *);
>
>
> thanks,
> Tobin.
--
Jani Nikula, Intel Open Source Graphics Center
n/process/submitting-drivers.rst 。
> 何子目录。
> 为一个单独的文件创建补丁，一般来说这样做就够了：
>
> -SRCTREE= linux-2.6
> -MYFILE= drivers/net/mydriver.c
> +SRCTREE=linux-2.6
> +MYFILE=drivers/net/mydriver.c
>
> cd $SRCTREE
> cp $MYFILE $MYFILE.orig
> @@ -63,7 +63,7 @@ Documentation/process/submitting-drivers.rst 。
> 为多个文件创建补丁，你可以解开一个没有修改过的内核源代码树，然后和你自
> 己的代码树之间做 diff 。例如：
>
> -MYSRC= /devel/linux-2.6
> +MYSRC=/devel/linux-2.6
>
> tar xvfz linux-2.6.12.tar.gz
> mv linux-2.6.12 linux-2.6.12-vanilla
--
Jani Nikula, Intel Open Source Graphics Center
nx/kerneldoc.py | 48 ---
> Documentation/sphinx/kernellog.py | 28 ++
> Documentation/sphinx/kfigure.py | 38 +---
> 3 files changed, 87 insertions(+), 27 deletions(-)
> create mode 100644 Documentation/sphinx/kernellog.py
--
Jani Nikula, Intel Open Source Graphics Center
self.state.memo.reporter = AutodocReporter(result,
> self.state.memo.reporter)
> +self.state.memo.title_styles, self.state.memo.section_level =
> [], 0
> +try:
> +self.state.nested_parse(result, 0, node, match_titles=1)
> + finally:
> +
> RemovedInSphinx30Warning: app.override_domain() is deprecated. Use
> app.add_domain() with override option instead.
> app.override_domain(CDomain)
>
> Otherwise, it builds.
Please share your Sphinx version (sphinx-build --version).
BR,
Jani.
--
Jani Nikula, Intel Open Source Graphics Center
(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1;
> else echo 0; fi)
> HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else
> echo 0; fi)
--
Jani Nikula, Intel Open Source Graphics Center
ested if CONFIG_HEADER_TEST is enabled. This will
generate a dummy C file per header that gets built as part of extra-y.
Cc: Chris Wilson
Cc: Masahiro Yamada
Cc: Michal Marek
Cc: Sam Ravnborg
Signed-off-by: Jani Nikula
---
v2: changes suggested by Masahiro:
http://mid.mail-archive.com/CAK
line toward the beginning of
> +the development cycle in order to pick up changes and fixes done elsewhere
> +in the tree. As always, such a merge should pick a well-known release
> +point rather than some random spot. If your upstream-bound branch has
> +emptied entirely into the mainline during the merge window, you can pull
> it +forward with a command like::
> +
> + git merge v5.2-rc1^0
> +
> +The "^0" will cause Git to do a fast-forward merge (which should be
> +possible in this situation), thus avoiding the addition of a spurious
> merge +commit.
> +
> +The guidelines laid out above are just that: guidelines. There will
> always +be situations that call out for a different solution, and these
> guidelines +should not prevent developers from doing the right thing when
> the need +arises. But one should always think about whether the need has
> truly +arisen and be prepared to explain why something abnormal needs to
> be done. --
> 2.21.0
>
--
Jani Nikula, Intel Open Source Graphics Center
hat doesn't really benefit
>from syntax highlighting, especially short snippets. Use
>``.. code-block:: `` for longer code blocks that benefit
> - from highlighting.
> + from highlighting. For a short snippet of code embedded in the text, use
> \`\`.
>
>
> the C domain
--
Jani Nikula, Intel Open Source Graphics Center
the Linux ABI files and produce a ReST book.
> +
> +=head1 SYNOPSIS
> +
> +B [--debug] ]
> +
> +=head1 OPTIONS
> +
> +=over 8
> +
> +=item B<--debug>
> +
> +Put the script in verbose mode, useful for debugging. Can be called multiple
> +times, to increase verbosity.
> +
> +=item B<--help>
> +
> +Prints a brief help message and exits.
> +
> +=item B<--man>
> +
> +Prints the manual page and exits.
> +
> +=back
> +
> +=head1 DESCRIPTION
> +
> +Parse the Linux ABI files from ABI DIR (usually located at Documentation/ABI)
> +and produce a ReST book containing the Linux ABI.
> +
> +=head1 BUGS
> +
> +Report bugs to Mauro Carvalho Chehab
> +
> +=head1 COPYRIGHT
> +
> +Copyright (c) 2016 by Mauro Carvalho Chehab .
> +
> +License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
> +
> +This is free software: you are free to change and redistribute it.
> +There is NO WARRANTY, to the extent permitted by law.
> +
> +=cut
--
Jani Nikula, Intel Open Source Graphics Center
gt; +self.warn(err)
> +if proc.returncode != 0:
> +raise self.severe(
> +u"command '%s' failed with return code %d"
> +% (cmd, proc.returncode)
> +)
> +except OSError as exc:
> +raise self.severe(u"problems with '%s' directive: %s."
> + % (self.name, ErrorString(exc)))
> +return unicode(out)
> +
> +def nestedParse(self, lines, fname):
> +content = ViewList()
> +node= nodes.section()
> +
> +if "debug" in self.options:
> +code_block = "\n\n.. code-block:: rst\n:linenos:\n"
> +for l in lines.split("\n"):
> +code_block += "\n" + l
> +lines = code_block + "\n\n"
> +
> +for c, l in enumerate(lines.split("\n")):
> +content.append(l, fname, c)
> +
> +buf = self.state.memo.title_styles, self.state.memo.section_level,
> self.state.memo.reporter
> +self.state.memo.title_styles = []
> +self.state.memo.section_level = 0
> +self.state.memo.reporter = AutodocReporter(content,
> self.state.memo.reporter)
> +try:
> +self.state.nested_parse(content, 0, node, match_titles=1)
> +finally:
> +self.state.memo.title_styles, self.state.memo.section_level,
> self.state.memo.reporter = buf
> +return node.children
--
Jani Nikula, Intel Open Source Graphics Center
On Fri, 14 Jun 2019, Greg Kroah-Hartman wrote:
> On Fri, Jun 14, 2019 at 04:31:56PM +0300, Jani Nikula wrote:
>> On Thu, 13 Jun 2019, Mauro Carvalho Chehab
>> wrote:
>> > From: Mauro Carvalho Chehab
>> >
>> > Add a script to parse the Documentation/ABI
On Fri, 14 Jun 2019, Mauro Carvalho Chehab wrote:
> Em Fri, 14 Jun 2019 16:06:03 +0200
> Greg Kroah-Hartman escreveu:
>
>> On Fri, Jun 14, 2019 at 04:42:20PM +0300, Jani Nikula wrote:
>> > 2) Have the python extension read the ABI files directly, without an
>> &g
On Mon, 17 Jun 2019, Greg Kroah-Hartman wrote:
> On Mon, Jun 17, 2019 at 03:36:17PM +0300, Jani Nikula wrote:
>> On Fri, 14 Jun 2019, Mauro Carvalho Chehab
>> wrote:
>> > Em Fri, 14 Jun 2019 16:06:03 +0200
>> > Greg Kroah-Hartman escreveu:
>> >
>
On Mon, 17 Jun 2019, Mauro Carvalho Chehab wrote:
> Yeah, I guess it should be possible to do that. How a python script
> can identify if it was called by Sphinx, or if it was called directly?
if __name__ == '__main__':
# run on the command-line, not imported
BR,
Jani.
We could even add an attic directory, which would be a suitable place
for things like zorro.txt. Attic is where I'd look for my old Amiga
hardware, so feels natural.
BR,
Jani.
--
Jani Nikula, Intel Open Source Graphics Center
is a better approach than preprocessing. Thanks for
doing this!
I toyed with something like this before, and the key difference here
seems to be ignoring literal blocks. The problem seemed to be that
replacing blocks with syntax highlighting also removed the syntax
highlighting, with no way that I could find to bring it back.
Obviously it would be great to be able to add the cross references in
more places than just bulk text nodes, but this is a good start.
BR,
Jani.
> +
> +def setup(app):
> +app.connect('doctree-resolved', auto_markup)
> +return {
> +'parallel_read_safe': True,
> +'parallel_write_safe': True,
> +}
--
Jani Nikula, Intel Open Source Graphics Center
On Fri, 21 Jun 2019, Mauro Carvalho Chehab wrote:
> Em Wed, 19 Jun 2019 13:37:39 -0300
> Mauro Carvalho Chehab escreveu:
>
>> Em Tue, 18 Jun 2019 11:47:32 +0300
>> Jani Nikula escreveu:
>>
>> > On Mon, 17 Jun 2019, Mauro Carvalho Chehab
>> &g
C sources for header test (header-test-y target)
> +# header test (header-test-y target)
> # -----------
>
> -quiet_cmd_header_test = HDRTEST $@
> - cmd_header_test = echo "\#include \"$*.h\""
ard character is '%' instead of '*' because this is evaluated by
> $(filter-out ...) whereas header-test-pattern-y is evaluated by
> $(wildcard ...). This is a kludge, but seems useful in some places...
>
> Signed-off-by: Masahiro Yamada
Awesome! This will let us get
27;s
pretty much the only way to expose them and get them fixed/excluded, and
it's behind a config knob after all.
With the caveat that I didn't finish the build, but OTOH tested the
rainy day scenario and had the patch find issues it's meant to find:
Tested-by: Ja
y: Gabriel Krisman Bertazi
Fixes: c0d1b6ee780a ("kernel-doc: produce RestructuredText output")
Reviewed-by: Jani Nikula
> ---
> scripts/kernel-doc | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index
a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> new file mode 12
> index ..5ca6e8ba3682
> --- /dev/null
> +++ b/Documentation/SubmittingPatches
> @@ -0,0 +1 @@
> +./process/submitting-patches.rst
> \ No newline at end of file
--
Jani Niku
On Wed, 11 Jan 2017, Joe Perches wrote:
> On Wed, 2017-01-11 at 10:54 +0200, Jani Nikula wrote:
>> On Wed, 11 Jan 2017, Joe Perches wrote:
>> > Make these files symlinks to the .rst equivalents
>>
>> If we're going to do this (and I really don't mind eith
x27;s just a
kernel-doc and rst lint, not Sphinx lint. Whether that's a good or a bad
thing is debatable.
Anyway, I do think the approach of making 'make CHECK=the-tool C=1' work
is what we should aim at. Markus' patch could probably be made to do
that by accepting the
On Wed, 25 Jan 2017, Markus Heiser wrote:
> Am 25.01.2017 um 09:21 schrieb Jani Nikula :
>> Yes, see below. It's simplistic and it has an external dependency, but
>> it got the job done. And it does not depend on Sphinx; it's just a
>> kernel-doc and rst lint, no
ge should be clear: this needs to be split
into small, incremental changes. Just like we do everything in the
kernel.
BR,
Jani.
(*) Please do not get hung up on these numbers. The Python version does
more in some ways, but adds more deps such as fspath that's not
included in the fi
On Wed, 25 Jan 2017, Markus Heiser wrote:
> Am 25.01.2017 um 11:24 schrieb Jani Nikula :
>
>> Markus, thanks for your work on this.
>
> Thanks for your comments!
>
>> Excuse me for my bluntness, but I think changing everything in a single
>> commit, or ev
On Thu, 26 Jan 2017, Markus Heiser wrote:
> Am 25.01.2017 um 21:59 schrieb Jani Nikula :
>
>>> But the problem I see here is, that the perl script generates a
>>> reST output which I can't use. As an example we can take a look at
>>> the man-page builder I
witching to a homebrew Python parser first does not preclude a
unicorn hunt later.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo
al usage, but it doesn't appear in the public documentation.
> Does that seem reasonable, or am I just being weird?
The request isn't weird, but I find the '-' prefixes there aesthetically
displeasing. I think I'd prefer fixing this in the inline member
docume
AULT
target for HAVE_SPHINX=0.
Reported-by: Jim Davis
Reference:
http://lkml.kernel.org/r/ca+r1zhjrvqkjpxgogb_boax2hkfb+qqcttzffbmfeh1mfee...@mail.gmail.com
Signed-off-by: Jani Nikula
---
Documentation/Makefile.sphinx | 7 +--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git
On Mon, 30 Jan 2017, Jani Nikula wrote:
> Make targets that don't depend on Sphinx work without warnings about
> missing Sphinx. 'make cleandocs' will work without Sphinx just fine, and
> the targets that are no-ops for Sphinx should just be skipped. Move them
> outsid
;t know how to tell Sphinx to find them there.
>
> Are these issues likely to be fixed?
>
> Ben.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
+ cmd_gendot = dot -Tsvg $2 > $3 || { rm -f $3; exit 1; }
I'd just use dot -o.
>
> %.pdf: %.svg
> @$(call cmd,genpdf,$<,$@)
>
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
/camuhmdvxqph7-9xj+ye_pgoa+-fe0969cskoehyh3uubycr...@mail.gmail.com
Reported-by: Geert Uytterhoeven
References: http://lkml.kernel.org/r/1485816692.2900.17.ca...@decadent.org.uk
Reported-by: Ben Hutchings
Cc: Jonathan Corbet
Signed-off-by: Jani Nikula
---
Documentation/Makefile.sphinx | 1 +
1 file
On Wed, 01 Feb 2017, Jonathan Corbet wrote:
> On Tue, 31 Jan 2017 20:18:05 +0200
> Jani Nikula wrote:
>
>> Considering the small amount of python code to compile (assuming sphinx
>> itself has .pyc around), the impact on build is neglible.
>
> Hey...don't you
'internal': directives.unchanged,
> @@ -74,6 +75,8 @@ class KernelDocDirective(Directive):
> export_file_patterns = str(self.options.get('internal')).split()
> elif 'doc' in self.options:
> cmd += ['-function'
s already an improvement.
> again = false;
> for (i = 0; i < JUMP_NB && keys[i]; i++)
> if (dres == keys[i]) {
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
put file
> even if it fails. So changing to -o doesn't fix anything.
Ugh. :(
> Please apply the original patch.
Ack.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
On Wed, 08 Feb 2017, changbin...@intel.com wrote:
> From: Changbin Du
>
> Prompt user how to quickly jump to the item he/she is interested in.
>
> Signed-off-by: Changbin Du
> Reviewed-by: Jani Nikula
This is assuming too much... but I looked at it now, and it looks good
to
und/soc/soc-core.c:2508: ERROR: Unknown target name: "snd_soc_daifmt".
> ./sound/core/jack.c:312: ERROR: Unknown target name: "snd_jack_btn".
> make[2]: *** [linux-user.pdf] Error 1
> make[1]: *** [pdfdocs] Error 2
> make: *** [pdfdocs] Error 2
--
Jani Nikula, Intel Open So
;, i.e. anything with
the docs suffix. I thought it would be better to call out the targets
explicitly, but perhaps that's not the case if it encourages targets
without docs suffix. Otherwise we'll have to keep touching
no-dot-config-targets too, which is not desirable ('make linkcheck&
sonally I prefer sending
updated patches in-reply-to the previous ones when they are single
patches or updates to just a few patches in a series. When updating more
than a few patches in a series, I'd repost the entire series as a new
thread and reference the previous series in a cover letter.
On Tue, 14 Feb 2017, Jonathan Corbet wrote:
> On Tue, 14 Feb 2017 15:52:10 +0200
> Jani Nikula wrote:
>
>> On Tue, 14 Feb 2017, Remy Leone wrote:
>> > I've got a question, when I receive review on a patch, is it better to
>> > resubmit or to reply insid
entation/media/Makefile
> +++ b/Documentation/media/Makefile
> @@ -103,6 +103,7 @@ html: all
> epub: all
> xml: all
> latex: $(IMGPDF) all
> +linkcheckdocs:
Argh, this makefile is called with the Sphinx builder as target,
i.e. linkcheck instead of linkcheckdocs, leading to
make[2]
docs latexdocs pdfdocs htmldocs mandocs
> installmandocs epubdocs cleandocs
> +DOC_TARGETS := xmldocs sgmldocs psdocs latexdocs pdfdocs htmldocs mandocs
> installmandocs epubdocs cleandocs linkcheckdocs
> PHONY += $(DOC_TARGETS)
> $(DOC_TARGETS): scripts_basic FORCE
> $(Q)$(MAKE) $(build)=scripts build_docproc build_check-lc_ctype
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
standard output and to output.txt in the output
> directory.
>
> Signed-off-by: Rémy Léone
Thanks for the updates!
Reviewed-by: Jani Nikula
Tested-by: Jani Nikula
> ---
> Documentation/DocBook/Makefile | 1 +
> Documentation/Makefile.sphinx | 4
> Docu
.
Why do you say O= isn't useful with the targets? The goal was that it
would work as expected, and it did work in the past. But, as with
everything, if there's no automated testing, it ceases to exist. :(
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscri
tes there have been over the years, IMHO at some point we should
just announce that we'll do a scripted bulk conversion of them to rst
unless people step up to do a better job. Give them a release cycle or
so to do it. Maybe shove the rst files under Documentation/staging, or
label t
So please use make to run Sphinx, and have the prerequisites
generated. After that, you can achieve what you want by running
BUILDDIR=output sphinx-build . output -b linkcheck
in the Documentation directory, but it won't update the prerequisites.
BR,
Jani.
--
Jani Nikula, Intel Open Sour
On Mon, 13 Mar 2017, Tamara Diaconita wrote:
> -.. include:: kernel-parameters.txt
> +.. include:: kernel-parameters.TNT
Huh?
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body
; email to outreachy-kernel+unsubscr...@googlegroups.com.
>> To post to this group, send email to outreachy-ker...@googlegroups.com.
>> To view this discussion on the web visit
>> https://groups.google.com/d/msgid/outreachy-kernel/20170314083902.4491-1-diaconita.tamara%40gmail.
cumentation/sphinx/cdomain.py
> +++ b/Documentation/sphinx/cdomain.py
> @@ -44,7 +44,7 @@ from sphinx.domains.c import CDomain as Base_CDomain
> __version__ = '1.0'
>
> # Get Sphinx version
> -major, minor, patch = map(int, sphinx.__version__.split("."))
> +ma
> v2: correct spell (Jim)
>> >
>> > Changbin Du (2):
>> > kconfig/mconf: add jumping tip in title of search result textbox
>> > Documentation/kconfig: add search jump feature description
>> >
>> > Documentation/kbuild/kconfig.txt | 4
ion/sphinx: rename kernel-doc.py to kerneldoc.py") to
appease Python and its module naming conventions.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord.
==
>
> @@ -475,7 +496,7 @@ can also benefit non-OTG products.
> - Also on the host side, a driver must support the OTG "Targeted
> Peripheral List". That's just a whitelist, used to reject peripherals
> not supported with a given Linux OTG host. *This whitelist is
> - product-specific; each product must modify ``otg_whitelist.h`` to
> + product-specific; each product must modify* ``otg_whitelist.h`` *to
> match its interoperability specification.*
>
> Non-OTG Linux hosts, like PCs and workstations, normally have some
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
On Thu, 30 Mar 2017, Jani Nikula wrote:
> On Wed, 29 Mar 2017, Mauro Carvalho Chehab wrote:
>> The pandoc conversion is not perfect. Do handwork in order to:
>>
>> - add a title to this chapter;
>> - use the proper warning and note markups;
>> - use kernel-d
I'm in favor of just bulk converting the rest of
the .tmpl files using Documentation/sphinx/tmplcvt, get rid of DocBook
and be done with it, and have the crowds focus on rst.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
exit
> +fi
> +
> +DIR=$(dirname $0)
>
> in=$1
> rst=$2
> tmp=$rst.tmp
>
> cp $in $tmp
> -sed --in-place -f convert_template.sed $tmp
> +sed --in-place -f $DIR/convert_template.sed $tmp
> pandoc -s -S -f docbook -t rst -o $rst $tmp
> -sed --in-place
fns_this_file.append(f)
> +elif 'unused-functions' in self.options:
> +for f in _used_fns_this_file:
> +cmd += ['-nofunction', f]
> elif 'functions' in self.options:
> for f in str(self.op
On Mon, 03 Apr 2017, Johannes Berg wrote:
> On Fri, 2017-03-31 at 15:54 +0300, Jani Nikula wrote:
>>
>> I'm sure the parameter name could be improved to capture what you
>> mean better; alas I don't have a suggestion.
>
> Yes, that's a fair point - p
kernel's boot-time parameters. Any patch which adds new parameters
> +should add the appropriate entries to this file.
>
> Any new configuration options must be accompanied by help text which
> clearly explains the options and when the user might want to select them.
--
he document references into :ref: links
Thanks, this seems like a much better change to me.
Reviewed-by: Jani Nikula
Jon, Mauro, am I right in that the only place that actually leads to the
development process documentation that starts at 1.Intro.rst is in fact
submitting-patches.rst? It's no
oo, making much more documentation human readable (and writable)
without additional processing.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
or want anyone to go overboard with markup. I don't
think it's unreasonable to make small concessions to improve generated
documentation for people who care about it even if you don't.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this li
On Mon, 15 May 2017, Peter Zijlstra wrote:
> On Mon, May 15, 2017 at 01:29:58PM +0300, Jani Nikula wrote:
>> On Mon, 15 May 2017, Peter Zijlstra wrote:
>> > The intention is to aid readability. Making comments worse so that some
>> > retarded script can generate bet
list (Cc'd),
our CI will run a bunch of tests on it, exercising our use of the I2C
adapter interfaces for display data channel and I2C over Display Port
native aux.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubsc
.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
ell them what the
> site is about.
The original index.rst including the lame title was autogenerated by
'sphinx-quickstart' and I failed to make it less lame. Thanks for fixing
this.
Acked-by: Jani Nikula
>
> Signed-off-by: Konstantin Ryabitsev
> ---
> Documentation/in
On Tue, 21 Nov 2017, "Tobin C. Harding" wrote:
> On Wed, Nov 15, 2017 at 04:09:32PM +0200, Jani Nikula wrote:
>> On Wed, 15 Nov 2017, "Tobin C. Harding" wrote:
>> > Original email thread
>> >
>> > https://lkml.org/lkml/2
gt;> if makefile_version and makefile_patchlevel:
>> version = release = makefile_version + '.' + makefile_patchlevel
>> else:
>> -sys.stderr.write('Warning: Could not extract kernel version\n')
>> version = release = "u
e:
:License: SPDX-License-Identifier: GPL-2.0
:SPDX: SPDX-License-Identifier: GPL-2.0
:SPDX-License-Identifier: GPL-2.0
BR,
Jani.
[1]
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists
[2] https://www.kernel.org/doc/html/latest/driver-api/device-io.html
--
Jani Nikula,
On Thu, 04 Jan 2018, Knut Omang wrote:
> Add scripts/runchecks which has generic support for running
> checker tools in a convenient and user friendly way that
> the author hopes can contribute to rein in issues detected
> by these tools in a manageable and convenient way.
>
> scripts/runchecks pr
On Thu, 04 Jan 2018, Knut Omang wrote:
> On Thu, 2018-01-04 at 17:50 +0200, Jani Nikula wrote:
>> On Thu, 04 Jan 2018, Knut Omang wrote:
>> > Add scripts/runchecks which has generic support for running
>> > checker tools in a convenient and user friendly way tha
I listed a couple below. If either seem worth
> pursuing, I'd be happy to take up implementing them. Else, or if
> they've already been discussed, please let me know.
Related, see scripts/documentation-file-ref-check.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
;s replacing doctree
nodes with ones that have reference nodes within them. It's more
complicated, but at that stage we can ignore stuff that should stay
verbatim. I think it's also possible to check that the reference targets
actually exist. In short, at that phase we have all the knowl
of any
paragraph. The :: will be omitted if it is preceded by whitespace. The
:: will be converted to a single colon if preceded by text"
BR,
Jani.
[1] http://docutils.sourceforge.net/docs/user/rst/quickref.html#literal-blocks
--
Jani Nikula, Intel Open Source Technology Center
--
To unsu
1 - 100 of 483 matches
Mail list logo
