Re: [PATCH v2 1/2] Documentation/sphinx: allow "functions" with no parameters

cmd += ['-function', f] > +functions = self.options.get('functions').split() > +if functions: > +for f in functions: > +cmd += ['-function', f] > +else: > +cmd += ['-no-doc-sections'] >

Re: [PATCH 1/2] Documentation/sphinx: add "nodocs" directive

On Tue, 19 Jun 2018, Mike Rapoport wrote: > On Tue, Jun 19, 2018 at 10:29:20AM +0300, Jani Nikula wrote: >> On Tue, 19 Jun 2018, Mike Rapoport wrote: >> > On Mon, Jun 18, 2018 at 11:01:32PM +0300, Jani Nikula wrote: >> >> On Mon, 18 Jun 2018, Mike Rapoport

Re: [PATCH 1/2] Documentation/sphinx: add "nodocs" directive

On Tue, 19 Jun 2018, Mike Rapoport wrote: > On Mon, Jun 18, 2018 at 11:01:32PM +0300, Jani Nikula wrote: >> On Mon, 18 Jun 2018, Mike Rapoport wrote: >> > When kernel-doc:: specified in .rst document without explicit directives, >> > it outputs both comment and DOC:

Re: [PATCH 1/2] Documentation/sphinx: add "nodocs" directive

tions'] > > for pattern in export_file_patterns: > for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern): -- Jani Nikula, Intel Open Source Graphics 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

Re: [RFC PATCH 1/2] scripts/kernel-doc: Auto-detect common code-blocks

k is a literal block. Adding heuristics (especially ones based on English language magic words) will lead to bigger problems than it's trying to solve. 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

Re: [PATCH 05/18] docs: core-api: add cachetlb documentation

--- a/Documentation/translations/ko_KR/memory-barriers.txt >> +++ b/Documentation/translations/ko_KR/memory-barriers.txt >> @@ -2846,7 +2846,7 @@ CPU 의 캐시에서 RAM 으로 쓰여지는 더티 캐시 라인에 의해 덮 >> 문제를 해결하기 위해선, 커널의 적절한 부분에서 각 CPU 의 캐시 안의 문제가 되는 >> 비트들을 무효화 시켜야 합니다. >> &g

Re: [PATCH] MAINTAINERS & files: Canonize the e-mails I use at files

s in the sources. Do we expect them all to be up-to-date too? 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

Re: [PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art

> -Illustration of the muxes behind a connector that supports an alternate mode: > +Illustration of the muxes behind a connector that supports an alternate > mode:: > > > | Connector | --

Re: [PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art

> Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C > Multiplexers") > Signed-off-by: Heikki Krogerus <heikki.kroge...@linux.intel.com> Reviewed-and-tested-by: Jani Nikula <jani.nik...@intel.com> > --- > Changed since v1: > - Using literal-bl

Re: [PATCH] Documentation: typec.rst: Mark ascii art as a comment

> Illustration of the muxes behind a connector that supports an alternate mode: > > - > +.. > | Connector | > > |

Re: [PATCH v2] Documentation/CodingStyle: Add an example for braces

On Wed, 21 Mar 2018, Jonathan Corbet <cor...@lwn.net> wrote: > To head that off, I think I'll apply your first version instead, sorry > Jani. No worries. BR, Jani. -- Jani Nikula, Intel Open Source Technology Center -- To unsubscribe from this list: send the line "unsu

Re: [PATCH] Documentation/CodingStyle: Add an example for braces

Jani. > + > +.. code-block:: c > + > + while (condition) { > + if (test) > + do_something(); > + } > + > 3.1) Spaces > *** > > > -- > To unsubscribe from this list: send the line "unsubscribe linux-doc

Re: [PATCH v3] Documentation/sphinx: Fix Directive import error

ve which has been available since > docutils 0.5 released in 2009. > > Bugzilla: https://bugzilla.opensuse.org/show_bug.cgi?id=1083694 > Co-developed-by: Takashi Iwai <ti...@suse.de> > Signed-off-by: Matthew Wilcox <mawil...@microsoft.com> I think this is the best approach

Re: [PATCH v2] Documentation/sphinx: Fix Directive import error

+except ImportError: > +from sphinx.util.compat import Directive > from sphinx.ext.autodoc import AutodocReporter > > __version__ = '1.0' -- 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

Re: [PATCH v3 05/10] pwm: add PWM mode to pwm_config()

m_config(pchip->pwmd, duty, period, BIT(ffs(caps.modes) - 1)); > > Well... I admit I've only really looked at the patches that impact > backlight but dispersing this really odd looking bit twiddling > throughout the kernel doesn't strike me a great API design. > > IMHO callers should

Re: [PATCH 0/6] Add support for in-line nested struct comments

c commit while applying patch 6, but I can't find the others. I guess applied literally meant just applied, not pushed... ;) BR, Jani. -- Jani Nikula, Intel Open Source Technology Center -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body

Re: [PATCH 8/8] docs: kernel-doc: Don't mangle literal code blocks in comments

t; Apply a hack to the output code to recognize literal blocks and avoid > performing any special markup on them. It's ugly, but that means it fits > in well with the rest of the script. With emphasis on part (d) of the reviewer's statement of oversight, Reviewed-by: Jani Nikula <jan

Re: [PATCH 1/8] docs: kernel-doc: Get rid of xml_escape() and friends

f-by: Jonathan Corbet <cor...@lwn.net> Reviewed-by: Jani Nikula <jani.nik...@intel.com> > --- > scripts/kernel-doc | 65 > -- > 1 file changed, 9 insertions(+), 56 deletions(-) > > diff --git a/scripts/kernel-doc b/sc

Re: [PATCH v4 16/18] scripts: kernel-doc: improve nested logic to handle multiple identifiers

ould be slightly more elegant to be able to leave out "channel." here and deduce that from the context... but the above matches what you'd write in the higher level struct comment, and produces the same output. It works and it's really simple. I like it. Please submit this as a proper patch,

Re: [PATCH v4 16/18] scripts: kernel-doc: improve nested logic to handle multiple identifiers

/$1/; > + next if (($name =~ m/^\s*$/)); > + if ($id =~ m/^\s*$/) { > + # anonymous struct/union > + $newmember .= "$type > $nam

Re: [PATCH 5/8] docs: kernel-doc: Move STATE_BODY processing to a separate function

On Fri, 09 Feb 2018, Linus Torvalds <torva...@linux-foundation.org> wrote: > On Fri, Feb 9, 2018 at 1:32 AM, Jani Nikula <jani.nik...@linux.intel.com> > wrote: >>> + # miguel-style comment kludge, look for blank lines after >>> + # @parameter

Re: [PATCH 6/8] docs: kernel-doc: Move STATE_PROTO processing into its own function

On Wed, 07 Feb 2018, Jonathan Corbet <cor...@lwn.net> wrote: > Move the top-level prototype-processing code out of process_file(). > > Signed-off-by: Jonathan Corbet <cor...@lwn.net> Reviewed-by: Jani Nikula <jani.nik...@intel.com> >

Re: [PATCH 5/8] docs: kernel-doc: Move STATE_BODY processing to a separate function

n_default; > + $contents = ""; > + } > + # look for doc_com + + doc_end: > + if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { > + print STDERR "${file}:$.: warning: suspicious ending line: $_"; > + ++$warnings; > + } > + >

Re: [PATCH 4/8] docs: kernel-doc: Move STATE_NAME processing into its own function

passing, but looks okay. Reviewed-by: Jani Nikula <jani.nik...@intel.com> > --- > scripts/kernel-doc | 137 > - > 1 file changed, 72 insertions(+), 65 deletions(-) > > diff --git a/scripts/kernel-doc b/scripts/kern

Re: [PATCH 2/8] docs: kernel-doc: Rename and split STATE_FIELD

ting the script won. But just barely. Reviewed-by: Jani Nikula <jani.nik...@intel.com> > --- > scripts/kernel-doc | 22 +++--- > 1 file changed, 11 insertions(+), 11 deletions(-) > > diff --git a/scripts/kernel-doc b/scripts/kernel-doc > index 5aa4ce21

Re: [PATCH 1/8] docs: kernel-doc: Get rid of xml_escape() and friends

$contents ne "") { > $contents .= "\n"; > - dump_section($file, $section, xml_escape($contents)); > + dump_section($file, $section, $contents); > $section = $section_default; > $contents = ""; > } > @@ -2072,7 +2025,7 @@ sub process_file($) { > } elsif ($state == STATE_DOCBLOCK) { > if (/$doc_end/) > { > - dump_doc_section($file, $section, > xml_escape($contents)); > + dump_doc_section($file, $section, $contents); > $section = $section_default; > $contents = ""; > $function = ""; -- 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

Re: [PATCH] Documentation/process: kernel maintainer PGP guide

ve the Maintainer: bit from the end near the top as a reStructuredText field list. See 'git grep :Author:' under Documentation for examples. Could even add a MAINTAINERS entry to improve your chances of being Cc'd on changes. BR, Jani. -- Jani Nikula, Intel Open Source Technology Center -- To u

Re: kernel.org documentation link (was Re: Protecting code integrity with PGP)

On Fri, 19 Jan 2018, Konstantin Ryabitsev <konstan...@linuxfoundation.org> wrote: > On 2018-01-19 03:37 AM, Jani Nikula wrote: >> On a side note, I was browsing for the generated kernel documentation at >> https://www.kernel.org/ and realized that AFAICT there are

Re: Protecting code integrity with PGP (kernel developer version)

On Thu, 18 Jan 2018, Randy Dunlap <rdun...@infradead.org> wrote: > On 01/18/2018 06:09 AM, Jani Nikula wrote: >> On Thu, 11 Jan 2018, Konstantin Ryabitsev <konstan...@linuxfoundation.org> >> wrote: >>> On Wed, Jan 10, 2018 at 02:05:16PM -0700, Jonathan Co

Re: Protecting code integrity with PGP (kernel developer version)

we can see if that version is > something that should go into the doc tree or continue to live > externally. Converting from .md into .rst is straightforward enough. If you all choose to host it externally after all, I think the kernel documentation should at least have a minimal document poin

Re: [RFC] doc: fix code snippet build warnings

On Tue, 16 Jan 2018, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 16.01.2018 um 11:22 schrieb Jani Nikula <jani.nik...@linux.intel.com>: >> >> On Wed, 10 Jan 2018, Jonathan Corbet <cor...@lwn.net> wrote: >>> On Wed, 10 Jan 2018 15:04:53 +1100

Re: [RFC] doc: fix code snippet build warnings

ed onto the very end 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 Tech

Re: [RFC] doc: fix code snippet build warnings

s 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 knowledge about the rst structure, parsed

Re: [RFC] Tools to fix/prevent broken Documentation file references

future breakage. 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

Re: [PATCH v3 1/1] runchecks: Generalize make C={1,2} to support multiple checkers

On Thu, 04 Jan 2018, Knut Omang <knut.om...@oracle.com> wrote: > On Thu, 2018-01-04 at 17:50 +0200, Jani Nikula wrote: >> On Thu, 04 Jan 2018, Knut Omang <knut.om...@oracle.com> wrote: >> > Add scripts/runchecks which has generic support for running >> >

Re: [PATCH v3 1/1] runchecks: Generalize make C={1,2} to support multiple checkers

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.

Re: Documentation license

apply. For example: :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

Re: [PATCH] docs: Remove "could not extract kernel version" warning

@@ -88,7 +88,6 @@ finally: >> 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 = &

Re: [PATCH] docs: add submitting-pull-requests.rst

On Tue, 21 Nov 2017, "Tobin C. Harding" <m...@tobin.cc> wrote: > On Wed, Nov 15, 2017 at 04:09:32PM +0200, Jani Nikula wrote: >> On Wed, 15 Nov 2017, "Tobin C. Harding" <m...@tobin.cc> wrote: >> > Original email thread >> > >>

Re: [PATCH] docs: add submitting-pull-requests.rst

>> > + >> > +Note: please use the git protocol (for justification from Linus see >> > referenced >> > +email thread). >> >> We need a reference to that thread. >> >> > +If the char-misc-4.15-rc1 tag is not present in the repo th

Re: [PATCH] Check all .c files for bad kernel-doc comments

On Mon, 30 Oct 2017, Matthew Wilcox <wi...@infradead.org> wrote: > On Mon, Oct 30, 2017 at 05:19:18PM +0200, Jani Nikula wrote: >> Related, there was also a script to do reStructuredText lint style >> checks in addition to the kernel-doc checks using make CHECK and >&g

Re: [PATCH] Check all .c files for bad kernel-doc comments

-- > 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 -- 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

Re: ReST questions

MOP. BR, Jani. [1] http://docutils.sourceforge.net/docs/ref/doctree.html -- 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

Re: Documentation: add Kernel Driver Statement to the kernel

file, you can read it as-such, right? *cough* reStructuredText *cough* 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

Re: [PATCH 3/8] Documentation: fix ref to workqueue content

ueues. > + href="https://www.kernel.org/doc/Documentation/core-api/workqueue.rst;>workqueues. > > > The requesting task still does counter snapshotting and funnel-lock -- Jani Nikula, Intel Open Source Technology Center -- To unsubscribe from this list: send the line "

Re: [PATCH] Documentation: add script and build target to check for broken file references

On Mon, 09 Oct 2017, Tom Saeger <tom.sae...@oracle.com> wrote: > On Mon, Oct 09, 2017 at 03:26:15PM +0000, Jani Nikula wrote: >> Add a simple script and build target to do a treewide grep for >> references to files under Documentation, and report the non-existing >&g

[PATCH] Documentation: add script and build target to check for broken file references

accurate though. We've moved files around enough to make having this worthwhile. Signed-off-by: Jani Nikula <jani.nik...@intel.com> --- Documentation/Makefile | 4 Makefile | 2 +- scripts/documentation-file-ref-check | 15 +++ 3 files c

Re: [PATCH 01/10] scripts: kernel-doc: get rid of unused output formats

As ReST is text, there's not much sense on outputting > on a different text format. > > After this patch, only man and rst output formats are > supported. FWIW, Acked-by: Jani Nikula <jani.nik...@intel.com> Please do keep at least two output formats going forward. Otherwise the

[PATCH] Documentation/sphinx: fix kernel-doc decode for non-utf-8 locale

rdun...@infradead.org> Cc: Jonathan Corbet <cor...@lwn.net> Cc: Mauro Carvalho Chehab <mche...@s-opensource.com> Signed-off-by: Jani Nikula <jani.nik...@intel.com> --- Documentation/sphinx/kerneldoc.py | 8 +++- 1 file changed, 3 insertions(+), 5 deletions(-) diff --

Re: [PATCH 1/2] docs: kernel-doc comments are ASCII

On Thu, 31 Aug 2017, Randy Dunlap <rdun...@infradead.org> wrote: > On 08/31/17 09:36, Jani Nikula wrote: >> On Thu, 31 Aug 2017, Jani Nikula <jani.nik...@linux.intel.com> wrote: >>> On Thu, 31 Aug 2017, Randy Dunlap <rdun...@infradead.org> wrote: >>&

Re: [PATCH 1/2] docs: kernel-doc comments are ASCII

On Thu, 31 Aug 2017, Jani Nikula <jani.nik...@linux.intel.com> wrote: > On Thu, 31 Aug 2017, Randy Dunlap <rdun...@infradead.org> wrote: >> On 08/31/17 07:17, Jonathan Corbet wrote: >>> On Thu, 31 Aug 2017 10:56:26 -0300 >>> Mauro Carvalho

Re: [PATCH 1/2] docs: kernel-doc comments are ASCII

wn to, and trying to work around non-UTF-8 LANG in both python 2 and 3 compatible ways. The odd thing is that I can reproduce the issue using a small python snippet, but not through Sphinx. 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

Re: [PATCH 1/2] docs: kernel-doc comments are ASCII

t recognize this. AFAIK that has nothing to do with python I/O, and everything to do with the encoding of that specific python source file. 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 me

Re: [PATCH] Documentation: small fixes for LEDs, hide notes about vibration

ple trigger. You get to upload effects and have the kernel play them for you, also stopping them in a timely manner regardless of the userspace dying and whatnot. I didn't double check now, but IIRC you could also link the input to force feedback, e.g. for touch vibrations. BR, Jani. -- Jani Nikula, Intel

Re: [PATCH V3 2/8] drivers: boot_constraint: Add boot_constraints_disable kernel parameter

LIST_HEAD(constraint_devices); >> static DEFINE_MUTEX(constraint_devices_mutex); >> >> +static bool boot_constraints_disabled; > > Again, this should only be an "enable" type of option, that kicks in if > you are using this type of bootloader/kernel interaction.

Re: [PATCH v2] docs: ReSTify table of contents in core.rst

On Fri, 25 Aug 2017, Josh Holland <anowlcalledj...@gmail.com> wrote: > On 2017-08-24, Jani Nikula wrote: >> On Wed, 23 Aug 2017, Josh Holland <anowlcalledj...@gmail.com> wrote: >> > Sphinx will now generate the table of contents automatically, which >> > av

Re: [PATCH v2] docs: ReSTify table of contents in core.rst

tents:: :local: Did you actually try this and look at the 'make htmldocs' results? I know I tried what I suggested: .. contents:: :local: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents BR, Jani. > > > Key Overview -- Jani Nikula, Intel Open

Re: docs build questions

s, but most of these comments are in source files > and requiring ``xyz_`` there is not nice. I assume very few actual symbols end in underscore, and this is more of a question of referencing a group of FOO_ prefixed symbols. In these cases, I prefer using FOO_* as it both avoids the problem and

Re: docs build questions

for the PDF build, to have different requirements for different builders. AFAICT you can't get at the builder directly from conf.py. 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

Re: [RFC PATCH 0/4] Documentation: generated module param documentation

On Mon, 24 Jul 2017, Jonathan Corbet <cor...@lwn.net> wrote: > On Wed, 19 Jul 2017 16:05:01 +0300 > Jani Nikula <jani.nik...@intel.com> wrote: > >> Hi Jon, all, here are some quick'n'dirty patches to semi-automatically >> generate module param documentation

[RFC PATCH 1/4] scripts: add modinfo-to-rst script to extract module parameters

Add a simple script to extract module param info from .ko using modinfo(8), and convert the results to rst. There's no filtering of rst special characters or anything. Signed-off-by: Jani Nikula <jani.nik...@intel.com> --- scripts/modinfo-to-rst | 24 1 file chang

[RFC PATCH 0/4] Documentation: generated module param documentation

that search engines can find them? And do we want to reuse the documentation already in place for parameters? BR, Jani. Jani Nikula (4): scripts: add modinfo-to-rst script to extract module parameters Documentation: start module parameter documentation autogenerated from modinfo

[RFC PATCH 2/4] Documentation: start module parameter documentation autogenerated from modinfo

are included as a toctree in kernel-parameters.rst. Signed-off-by: Jani Nikula <jani.nik...@intel.com> --- Documentation/admin-guide/kernel-parameters.rst| 8 ++ Documentation/admin-guide/kernel-parameters.txt| 14 --- Documentation/admin-guide/module-parameters/README

[RFC PATCH 3/4] Documentation: add drm and drm_kms_helper module param documentation

Obviously the MODULE_PARM_DESC documentation for drm_kms_helper.edid_firmware needs some updating before we could consider this. Signed-off-by: Jani Nikula <jani.nik...@intel.com> --- Documentation/admin-guide/kernel-parameters.txt| 18 --- .../admin-guide/module-para

Re: [PATCH] Make the main documentation title less Geocities

documentation, just tell 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 <jani.nik...@intel.com> > > Signed-off-by: Ko

Re: [PATCH 2/3] Documentation: Move visorbus documentation from staging to Documentation/

ot something as specific as this. 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

Re: [PATCH 0/8] i2c: refactor core and break out blocks

series to the intel-gfx 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 lin

Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to generate ReST

On Mon, 15 May 2017, Peter Zijlstra <pet...@infradead.org> wrote: > On Mon, May 15, 2017 at 01:29:58PM +0300, Jani Nikula wrote: >> On Mon, 15 May 2017, Peter Zijlstra <pet...@infradead.org> wrote: >> > The intention is to aid readability. Making comments worse so

Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to generate ReST

don't expect 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 list

Re: Missing File REPORTING-BUGS In Linux Kernel.

too, 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

Re: [PATCH V2] docs: process/4.Coding.rst: Fix a couple of document refs

<and...@digital-domain.net> > --- > V2 - Convert the document references into :ref: links Thanks, this seems like a much better change to me. Reviewed-by: Jani Nikula <jani.nik...@intel.com> Jon, Mauro, am I right in that the only place that actually leads to the development pr

Re: [PATCH] docs: process/4.Coding.rst: Re-flow a couple of paragraphs

admin-guide/kernel-parameters.rst describes all of > +the 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 opti

Re: [PATCH 1/2] Documentation/sphinx: kerneldoc: add "unused-functions"

On Mon, 03 Apr 2017, Johannes Berg <johan...@sipsolutions.net> 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

Re: [PATCH 1/2] Documentation/sphinx: kerneldoc: add "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.options.get('functions')).split(): > cmd += ['-function', f] > +

Re: [PATCH v2 01/22] tmplcvt: make the tool more robust

BR, Jani. > + echo "$0 " > + 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 -

Re: [PATCH 02/22] docs-rst: convert usb docbooks to ReST

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 &

Re: [PATCH 04/22] gadget.rst: Enrich its ReST representation and add kernel-doc tag

On Thu, 30 Mar 2017, Jani Nikula <jani.nik...@linux.intel.com> wrote: > On Wed, 29 Mar 2017, Mauro Carvalho Chehab <mche...@s-opensource.com> wrote: >> The pandoc conversion is not perfect. Do handwork in order to: >> >> - add a title to this chapter; >> -

Re: [PATCH 04/22] gadget.rst: Enrich its ReST representation and add kernel-doc tag

: > + > Peripheral Controller Drivers > = > > @@ -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 perip

Re: kerneldoc

ff742 ("Documentation/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 mes

Re: [PATCH v2 0/2] kconfig/mconf: propagate jumping function in search result view

t; >> > Documentation/kbuild/kconfig.txt | 4 >> > scripts/kconfig/mconf.c | 8 >> > 2 files changed, 8 insertions(+), 4 deletions(-) >> > >> > -- >> > 2.7.4 >> > >> >> -- >> Thanks, >> Changbin Du -- 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

Re: [PATCH 216/216] Use sphinx.version_info directly instead of parsing

index df0419c..984e327 100644 > --- a/Documentation/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.__v

Re: [Outreachy kernel] [PATCH] Documentation: x86: Fix typos

treachy-kernel/20170314083902.4491-1-diaconita.tamara%40gmail.com. >> For more options, visit https://groups.google.com/d/optout. >> > -- > 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 -- 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

Re: Error in make linkcheckdocs

e 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 Source Technology Ce

Re: [PATCH] docs: Fix htmldocs build failure

.tmpl files, and how few updates 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

Re: making documentation targets on v4.10 with Fedora 25

; by the top-level Makefile. 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 -- T

Re: [PATCH v4] Add a target to check broken external links in the Documentation

rview which ones are broken > and redirected to standard output and to output.txt in the output > directory. > > Signed-off-by: Rémy Léone <remy.le...@gmail.com> Thanks for the updates! Reviewed-by: Jani Nikula <jani.nik...@intel.com> Tested-by: Jani Nikula <jani.nik...@i

Re: [PATCH v3] Add a target to check broken external links in the Documentation

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) $(bui

Re: [PATCH v2] Add a target to check broken external links in the Documentation

t; --- a/Documentation/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, lea

Re: [PATCH] Add a target to check broken external links in the Documentation

On Tue, 14 Feb 2017, Jonathan Corbet <cor...@lwn.net> wrote: > On Tue, 14 Feb 2017 15:52:10 +0200 > Jani Nikula <jani.nik...@linux.intel.com> wrote: > >> On Tue, 14 Feb 2017, Remy Leone <remy.le...@gmail.com> wrote: >> > I've got a question, when

Re: [PATCH] Add a target to check broken external links in the Documentation

letter. 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

Re: [PATCH] Add a target to check broken external links in the Documentation

rgets 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' as-is runs the config target). In short, I think this should be called linkcheckdocs. BR

Re: make pdfdoc errors with 4.10-rc7

. > ./sound/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 Ni

Re: [PATCH v2 1/2] kconfig/mconf: add jumping tip in title of search result textbox

On Wed, 08 Feb 2017, changbin...@intel.com wrote: > From: Changbin Du <changbin...@intel.com> > > Prompt user how to quickly jump to the item he/she is interested in. > > Signed-off-by: Changbin Du <changbin...@intel.com> > Reviewed-by: Jani Nikula <jani.nik...@l

Re: [PATCH 2/3] doc-rst: Delete output of failed dot-SVG conversion

found that dot still touches the output 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 "unsubsc

Re: [PATCH 1/2] kconfig/mconf: add jumping tip in title of search result textbox

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

Re: [PATCH RESEND] Documentation/sphinx: prevent generation of .pyc files in the source tree

On Wed, 01 Feb 2017, Jonathan Corbet <cor...@lwn.net> wrote: > On Tue, 31 Jan 2017 20:18:05 +0200 > Jani Nikula <jani.nik...@intel.com> wrote: > >> Considering the small amount of python code to compile (assuming sphinx >> itself has .pyc around), the impact on b

[PATCH RESEND] Documentation/sphinx: prevent generation of .pyc files in the source tree

net> Signed-off-by: Jani Nikula <jani.nik...@intel.com> --- Documentation/Makefile.sphinx | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx index 707c65337ebf..91f541a52884 100644 --- a/Documentation/Makefile.sphinx +++ b/Docum

Re: [PATCH 2/3] doc-rst: Delete output of failed dot-SVG conversion

d_gendot = dot -Tsvg $2 > $3 > + 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

Re: Sphinx builds always write to the source directory

irectory, but I don'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 major

Re: [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0

On Mon, 30 Jan 2017, Jani Nikula <jani.nik...@intel.com> 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

  1   2   3   4   >