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

On Sat, May 13, 2017 at 12:11:09AM +0200, Peter Zijlstra wrote: > On Fri, May 12, 2017 at 06:51:50PM -0300, Mauro Carvalho Chehab wrote: > > > * Return: > > > * * 0 - ready to wait > > > * * 1 - acquired the lock > > > * * <0 - error > > > > > > I'm fine with either though, just curious

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

On Fri, May 12, 2017 at 06:51:50PM -0300, Mauro Carvalho Chehab wrote: > > * Return: > > * * 0 - ready to wait > > * * 1 - acquired the lock > > * * <0 - error > > > > I'm fine with either though, just curious if this would be an improvement, > > or if > > we have an established policy

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

On Fri, May 12, 2017 at 06:51:50PM -0300, Mauro Carvalho Chehab wrote: > Em Fri, 12 May 2017 09:41:22 -0700 > Darren Hart escreveu: > > > On Fri, May 12, 2017 at 10:59:47AM -0300, Mauro Carvalho Chehab wrote: > > > There are a few issues on some kernel-doc markups that was

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

Em Fri, 12 May 2017 09:41:22 -0700 Darren Hart escreveu: > On Fri, May 12, 2017 at 10:59:47AM -0300, Mauro Carvalho Chehab wrote: > > There are a few issues on some kernel-doc markups that was > > causing troubles with kernel-doc output on ReST format. > > Fix them. > > >

Re: [Resend][PATCH] cpufreq: intel_pstate: Document the current behavior and user interface

On Friday, May 12, 2017 03:20:48 PM Jonathan Corbet wrote: > On Fri, 12 May 2017 22:47:25 +0200 > "Rafael J. Wysocki" wrote: > > > > Hi Jon, > > > > > > All of the dependencies for this patch have been merged, so I can route it > > > through the PM tree. > > > > > > Please

Re: [Resend][PATCH] cpufreq: intel_pstate: Document the current behavior and user interface

On Fri, 12 May 2017 22:47:25 +0200 "Rafael J. Wysocki" wrote: > > Hi Jon, > > > > All of the dependencies for this patch have been merged, so I can route it > > through the PM tree. > > > > Please let me know if you prefer to take it into the documentation tree > >

Re: [Resend][PATCH] cpufreq: intel_pstate: Document the current behavior and user interface

On Friday, May 05, 2017 11:38:42 PM Rafael J. Wysocki wrote: > From: Rafael J. Wysocki > > Add a document describing the current behavior and user space > interface of the intel_pstate driver in the RST format and > drop the existing outdated intel_pstate.txt

Support for advanced documentation around data type definitions

Hello, Some data type definitions are provided by Linux source files. How would you like to see them represented in the documentation formats which are generated by the Sphinx software? Regards, Markus -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a

Re: [PATCH 03/36] docs-rst: convert kernel-locking to ReST

Am 12.05.2017 um 15:59 schrieb Mauro Carvalho Chehab : > Use pandoc to convert documentation to ReST by calling > Documentation/sphinx/tmplcvt script. > > - Manually adjust tables with got broken by conversion > > Signed-off-by: Mauro Carvalho Chehab

Re: [PATCH 03/36] docs-rst: convert kernel-locking to ReST

Am 12.05.2017 um 15:59 schrieb Mauro Carvalho Chehab : > Use pandoc to convert documentation to ReST by calling > Documentation/sphinx/tmplcvt script. > > - Manually adjust tables with got broken by conversion > > Signed-off-by: Mauro Carvalho Chehab

Re: [PATCH] mm: per-cgroup memory reclaim stats

On Fri, May 12, 2017 at 12:25:22PM +1000, Balbir Singh wrote: > On Thu, 2017-05-11 at 20:16 +0100, Roman Gushchin wrote: > > The meaning of each value is the same as for global counters, > > available using /proc/vmstat. > > > > Also, for consistency, rename mem_cgroup_count_vm_event() to > >

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

On Fri, May 12, 2017 at 10:59:47AM -0300, Mauro Carvalho Chehab wrote: > There are a few issues on some kernel-doc markups that was > causing troubles with kernel-doc output on ReST format. > Fix them. > > No functional changes. > > Signed-off-by: Mauro Carvalho Chehab

Re: [PATCH 01/36] docs-rst: convert kernel-hacking to ReST

Am 12.05.2017 um 15:59 schrieb Mauro Carvalho Chehab : > Use pandoc to convert documentation to ReST by calling > Documentation/sphinx/tmplcvt script. > > - Manually adjusted to use ..note and ..warning > - Minor fixes for it to be parsed without errors > - Use

[PATCH] Documentation: crypto: Fixed bugs, added example usage of calc_hash().

- Fixed bugs in example for shash and rng (added missing "*" and " *"). - Corrected pr_info() in calc_hash(). - Added example usage of calc_hash(). - No need for negate PTR_ERR to get error code, as crypto_alloc_rng already returns negative values like ERR_PTR(-ENOMEM). Fixed. Signed-off-by:

[PATCH 11/36] docs-rst: conf.py: sort LaTeX documents in alphabetical order

As we add more documents, it makes more sense to sort the entries there in alphabetical order, as it makes easier to check if something is not there. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 13 +++-- 1 file changed, 7 insertions(+), 6

[PATCH 16/36] docs-rst: add userspace API book to pdf output

The userspace API book was added without the bits required to generate PDF output. Add them. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/conf.py b/Documentation/conf.py index

[PATCH 22/36] fs: add a blank lines on some kernel-doc comments

Sphinx gets confused when it finds identation without a good reason for it and without a preceding blank line: ./fs/mpage.c:347: ERROR: Unexpected indentation. ./fs/namei.c:4303: ERROR: Unexpected indentation. ./fs/fs-writeback.c:2060: ERROR: Unexpected indentation. No

[PATCH 15/36] docs-rst: add sound book to pdf output

The sound subsystem book was added without the bits required to generate PDF output. Add them. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 2 ++ Documentation/sound/conf.py | 10 ++ 2 files changed, 12 insertions(+) create mode

[PATCH 20/36] docs-rst: don't ignore internal functions for jbd2 docs

Those functions are currently ignored, causing references at the documentation to be lost. Don't ignore it. Signed-off-by: Mauro Carvalho Chehab --- Documentation/filesystems/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git

[PATCH 19/36] fs: jbd2: make jbd2_journal_start() kernel-doc parseable

kernel-doc script expects that a function documentation to be just before the function, otherwise it will be ignored. So, move the kernel-doc markup to the right place. Signed-off-by: Mauro Carvalho Chehab --- fs/jbd2/transaction.c | 38

[PATCH 28/36] docs-rst: convert s390-drivers DocBook to ReST

Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/Makefile| 2 +- Documentation/DocBook/s390-drivers.tmpl | 161 --

[PATCH 06/36] locking.rst: add captions to two tables

Those tables have a "caption" at the end, but ReST actually expects it on a different way. Signed-off-by: Mauro Carvalho Chehab --- Documentation/kernel-hacking/locking.rst | 66 1 file changed, 34 insertions(+), 32 deletions(-) diff

[PATCH 10/36] conf.py: define a color for important markup on PDF output

As kdbg.rst uses the ".. important::" annotation, let's define a color for PDF output. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 8 +++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Documentation/conf.py

[PATCH 23/36] fs: eventfd: fix identation on kernel-doc

Sphinx require explicit tags in order to use a list of possible values, otherwise it produces this error: ./fs/eventfd.c:219: WARNING: Option list ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab --- fs/eventfd.c | 4 ++--

[PATCH 35/36] docs-rst: convert w1 book to ReST

Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/w1.tmpl | 101 - Documentation/driver-api/index.rst | 1 +

[PATCH 34/36] scsi: fix some kernel-doc markups

Sphinx is very pedantic with regards to ident/spacing. Fix some kernel-doc markups in order to solve those errors/warnings: ./drivers/scsi/scsicam.c:121: WARNING: Inline emphasis start-string without end-string. ./drivers/scsi/scsicam.c:121: WARNING: Inline emphasis start-string without

[PATCH 26/36] libata.rst: add c function and struct cross-references

Instead of just using text for functions and structs, use the C domain tags, in order to allow cross-referencing with the kernel-doc markups. Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/libata.rst | 244 ++-- 1 file

[PATCH 27/36] libata: fix identation on a kernel-doc markup

Sphinx got confused with the markup identation: ./drivers/ata/libata-scsi.c:3402: ERROR: Unexpected indentation. No functional changes. Signed-off-by: Mauro Carvalho Chehab --- drivers/ata/libata-scsi.c | 7 --- 1 file changed, 4 insertions(+), 3

[PATCH 21/36] fs: locks: Fix some troubles at kernel-doc comments

There are a few syntax violations that cause outputs of a few comments to not be properly parsed in ReST format. No functional changes. Signed-off-by: Mauro Carvalho Chehab --- fs/locks.c | 18 -- 1 file changed, 8 insertions(+), 10 deletions(-) diff

[PATCH 32/36] docs-rst: convert z8530book DocBook to ReST

Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Some manual adjustments were required due to some conversion error on some literals. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/Makefile | 2 +-

[PATCH 36/36] docs-rst: convert rapidio book to ReST

Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/Makefile | 4 +- Documentation/DocBook/rapidio.tmpl | 155 ---

Re: [PATCH 21/36] fs: locks: Fix some troubles at kernel-doc comments

On Fri, 2017-05-12 at 11:00 -0300, Mauro Carvalho Chehab wrote: > There are a few syntax violations that cause outputs of > a few comments to not be properly parsed in ReST format. > > No functional changes. > > Signed-off-by: Mauro Carvalho Chehab > --- > fs/locks.c

[PATCH 18/36] docs-rst: filesystems: use c domain references where needed

Instead of just mention the function names, use cross-references to the kernel-doc tags where pertinent. While not all function documentation is included here, I double-checked that all functions mentioned there still exists. Signed-off-by: Mauro Carvalho Chehab ---

[PATCH 01/36] docs-rst: convert kernel-hacking to ReST

Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. - Manually adjusted to use ..note and ..warning - Minor fixes for it to be parsed without errors - Use **bold** for emphasis. Signed-off-by: Mauro Carvalho Chehab ---

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

There are a few issues on some kernel-doc markups that was causing troubles with kernel-doc output on ReST format. Fix them. No functional changes. Signed-off-by: Mauro Carvalho Chehab --- include/linux/mutex.h | 6 +++--- kernel/futex.c | 40

[PATCH 12/36] docs-rst: conf.py: remove kernel-documentation from LaTeX

There's no kernel-documentation.rst file at Documentation/ anymore. So, remove it from the list of LaTeX-generated documents. Signed-off-by: Mauro Carvalho Chehab --- Documentation/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/Documentation/conf.py

[PATCH 17/36] docs-rst: convert filesystems book to ReST

Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/Makefile | 2 +- Documentation/DocBook/filesystems.tmpl | 381 -

[PATCH 08/36] docs-rst: convert kgdb DocBook to ReST

Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab --- Documentation/DocBook/Makefile| 2 +- Documentation/DocBook/kgdb.tmpl | 918 -

[PATCH 05/36] locking.rst: reformat locking table

Use a different markup for this table, in order to make it smaller when seeing in text mode. Signed-off-by: Mauro Carvalho Chehab --- Documentation/kernel-hacking/locking.rst | 37 1 file changed, 14 insertions(+), 23 deletions(-) diff

[PATCH 30/36] net: skbuff.h: properly escape a macro name on kernel-doc

The "%" escape code of kernel-doc only handle letters. It doesn't handle special chars. So, use the ``literal`` notation. That fixes this warning: ./include/linux/skbuff.h:2695: WARNING: Inline literal start-string without end-string. No functional changes. Signed-off-by: Mauro Carvalho Chehab

APPLY FOR YOUR URGENT LOAN AT 2%

* Do you need an urgent loan? We offer all kinds of loan * Very fast and urgent transfer to your bank account. * Payment begins (6) months after you get the money in your bank account * Low interest rates 2% * Payment of long-term (1-30 years) duration For more information and loan application