Groups > linux.kernel > #1642478 > unrolled thread

[PATCH v2 00/53] Get rid of Docbook

Started by	Mauro Carvalho Chehab <mchehab@s-opensource.com>
First post	2017-05-16 14:20 +0200
Last post	2017-05-19 01:10 +0200
Articles	17 on this page of 57 — 8 participants

Back to article view | Back to linux.kernel

  [PATCH v2 00/53] Get rid of Docbook Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
    [PATCH v2 18/53] docs-rst: filesystems: use c domain references where needed Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
    [PATCH v2 06/53] locking.rst: add captions to two tables Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
    [PATCH v2 33/53] scsi: fix some kernel-doc markups Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
    [PATCH v2 17/53] docs-rst: convert filesystems book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
    [PATCH v2 39/53] mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
      Re: [PATCH v2 39/53] mtd: adjust kernel-docs to avoid  Sphinx/kerneldoc warnings Boris Brezillon <boris.brezillon@free-electrons.com> - 2017-05-16 15:20 +0200
    [PATCH v2 16/53] docs-rst: add userspace API book to pdf output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 20/53] docs-rst: don't ignore internal functions for jbd2 docs Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 15/53] docs-rst: add sound book to pdf output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
      Re: [PATCH v2 15/53] docs-rst: add sound book to pdf output Takashi Iwai <tiwai@suse.de> - 2017-05-16 21:10 +0200
    [PATCH v2 31/53] docs-rst: convert z8530book DocBook to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 10/53] conf.py: define a color for important markup on PDF output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 44/53] MAINTAINERS: update old references for DocBook directory Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 02/53] kernel-hacking: update document Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
      [PATCH v2 53/53] kernel-doc: describe the ``literal`` syntax Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:20 +0200
      [PATCH v2 52/53] docs-rst: get rid of Documentation/sphinx/tmplcvt script Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:20 +0200
      [PATCH v2 50/53] fs: fix the location of the kernel-api book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:20 +0200
      [PATCH v2 51/53] usb: fix the comment with regards to DocBook Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:20 +0200
        Re: [PATCH v2 51/53] usb: fix the comment with regards to DocBook Felipe Balbi <balbi@kernel.org> - 2017-05-17 13:20 +0200
    [PATCH v2 14/53] docs-rst: add dev-tools book to pdf output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 29/53] net: skbuff.h: properly escape a macro name on kernel-doc Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 07/53] locking.rst: Update some ReST markups Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 09/53] kgdb.rst: Adjust ReST markups Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 47/53] irq: update genericirq book location Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 41/53] docs-rst: convert lsm from DocBook to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 46/53] ia64, scsi: update references for the device-io book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 05/53] locking.rst: reformat locking table Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 25/53] libata.rst: add c function and struct cross-references Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 36/53] docs-rst: convert librs book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 42/53] docs: remove DocBook from the building system Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 32/53] docs-rst: convert scsi DocBook to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 48/53] fs: update location of filesystems documentation Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 34/53] docs-rst: convert w1 book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 49/53] lib: update location of kgdb documentation Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 28/53] docs-rst: convert networking book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
      Re: [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups David Howells <dhowells@redhat.com> - 2017-05-16 14:40 +0200
    [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
      Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to  generate ReST Darren Hart <dvhart@infradead.org> - 2017-05-16 19:40 +0200
        Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to  generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:30 +0200
          Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to  generate ReST Darren Hart <dvhart@infradead.org> - 2017-05-16 21:10 +0200
    [PATCH v2 21/53] fs: add a blank lines on some kernel-doc comments Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 11/53] docs-rst: conf.py: sort LaTeX documents in alphabetical order Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 12/53] docs-rst: conf.py: remove kernel-documentation from LaTeX Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 43/53] docs: update old references for DocBook from the documentation Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
      Re: [PATCH v2 43/53] docs: update old references for DocBook from  the documentation Bjorn Helgaas <helgaas@kernel.org> - 2017-05-17 19:00 +0200
    [PATCH v2 13/53] docs-rst: add crypto API book to pdf output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
    [PATCH v2 22/53] fs: eventfd: fix identation on kernel-doc Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
    [PATCH v2 35/53] docs-rst: convert rapidio book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
    [PATCH v2 27/53] docs-rst: convert s390-drivers DocBook to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
    [PATCH v2 26/53] libata: fix identation on a kernel-doc markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
    [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
      Re: [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line Boris Brezillon <boris.brezillon@free-electrons.com> - 2017-05-16 15:20 +0200
    [PATCH v2 40/53] docs-rst: convert sh book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
    Re: [PATCH v2 00/53] Get rid of Docbook Jonathan Corbet <corbet@lwn.net> - 2017-05-18 19:30 +0200
      Re: [PATCH v2 00/53] Get rid of Docbook Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-19 01:10 +0200

Page 3 of 3 — ← Prev page 1 2 [3]

#1642730 — Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 20:30 +0200
Subject	Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST
Message-ID	<tHPom-Bv-13@gated-at.bofh.it>
In reply to	#1642691

Em Tue, 16 May 2017 10:35:40 -0700
Darren Hart <dvhart@infradead.org> escreveu:

> On Tue, May 16, 2017 at 09:15:56AM -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:
> > 
> > ./kernel/futex.c:492: WARNING: Inline emphasis start-string without end-string.
> > ./kernel/futex.c:1264: WARNING: Block quote ends without a blank line; unexpected unindent.
> > ./kernel/futex.c:1721: WARNING: Block quote ends without a blank line; unexpected unindent.
> > ./kernel/futex.c:2338: WARNING: Block quote ends without a blank line; unexpected unindent.
> > ./kernel/futex.c:2426: WARNING: Block quote ends without a blank line; unexpected unindent.
> > ./kernel/futex.c:2899: WARNING: Block quote ends without a blank line; unexpected unindent.
> > ./kernel/futex.c:2972: WARNING: Block quote ends without a blank line; unexpected unindent.
> > 
> > Fix them.
> > 
> > No functional changes.
> > 
> > Acked-by: Darren Hart (VMware) <dvhart@infradead.org>
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> > ---  
> 
> 
> What was the difference from v1? Quick scan didn't reveal anything obvious to
> me... (context left intact in case you want to point it out inline), but just a
> "Changes since v1" below the --- is always appreciated - even it it's "no
> changes, new commit log".

From v1, the .. note:: got removed. That's pretty much the same version
found on one of my replies + the addition of the warnings it produces
without the patch.

Regards,
Mauro

> 
> 
> >  include/linux/mutex.h  |  6 +++---
> >  kernel/futex.c         | 40 ++++++++++++++++++++--------------------
> >  kernel/locking/mutex.c |  6 +++---
> >  3 files changed, 26 insertions(+), 26 deletions(-)
> > 
> > diff --git a/include/linux/mutex.h b/include/linux/mutex.h
> > index 1127fe31645d..ffcba1f337da 100644
> > --- a/include/linux/mutex.h
> > +++ b/include/linux/mutex.h
> > @@ -214,9 +214,9 @@ enum mutex_trylock_recursive_enum {
> >   * raisins, and once those are gone this will be removed.
> >   *
> >   * Returns:
> > - *  MUTEX_TRYLOCK_FAILED    - trylock failed,
> > - *  MUTEX_TRYLOCK_SUCCESS   - lock acquired,
> > - *  MUTEX_TRYLOCK_RECURSIVE - we already owned the lock.
> > + *  - MUTEX_TRYLOCK_FAILED    - trylock failed,
> > + *  - MUTEX_TRYLOCK_SUCCESS   - lock acquired,
> > + *  - MUTEX_TRYLOCK_RECURSIVE - we already owned the lock.
> >   */
> >  static inline /* __deprecated */ __must_check enum mutex_trylock_recursive_enum
> >  mutex_trylock_recursive(struct mutex *lock)
> > diff --git a/kernel/futex.c b/kernel/futex.c
> > index 357348a6cf6b..b8ae87d227da 100644
> > --- a/kernel/futex.c
> > +++ b/kernel/futex.c
> > @@ -488,7 +488,7 @@ static void drop_futex_key_refs(union futex_key *key)
> >   *
> >   * Return: a negative error code or 0
> >   *
> > - * The key words are stored in *key on success.
> > + * The key words are stored in @key on success.
> >   *
> >   * For shared mappings, it's (page->index, file_inode(vma->vm_file),
> >   * offset_within_page).  For private mappings, it's (uaddr, current->mm).
> > @@ -1259,9 +1259,9 @@ static int lock_pi_update_atomic(u32 __user *uaddr, u32 uval, u32 newval)
> >   * @set_waiters:	force setting the FUTEX_WAITERS bit (1) or not (0)
> >   *
> >   * Return:
> > - *  0 - ready to wait;
> > - *  1 - acquired the lock;
> > - * <0 - error
> > + *  -  0 - ready to wait;
> > + *  -  1 - acquired the lock;
> > + *  - <0 - error
> >   *
> >   * The hb->lock and futex_key refs shall be held by the caller.
> >   */
> > @@ -1717,9 +1717,9 @@ void requeue_pi_wake_futex(struct futex_q *q, union futex_key *key,
> >   * hb1 and hb2 must be held by the caller.
> >   *
> >   * Return:
> > - *  0 - failed to acquire the lock atomically;
> > - * >0 - acquired the lock, return value is vpid of the top_waiter
> > - * <0 - error
> > + *  -  0 - failed to acquire the lock atomically;
> > + *  - >0 - acquired the lock, return value is vpid of the top_waiter
> > + *  - <0 - error
> >   */
> >  static int futex_proxy_trylock_atomic(u32 __user *pifutex,
> >  				 struct futex_hash_bucket *hb1,
> > @@ -1785,8 +1785,8 @@ static int futex_proxy_trylock_atomic(u32 __user *pifutex,
> >   * uaddr2 atomically on behalf of the top waiter.
> >   *
> >   * Return:
> > - * >=0 - on success, the number of tasks requeued or woken;
> > - *  <0 - on error
> > + *  - >=0 - on success, the number of tasks requeued or woken;
> > + *  -  <0 - on error
> >   */
> >  static int futex_requeue(u32 __user *uaddr1, unsigned int flags,
> >  			 u32 __user *uaddr2, int nr_wake, int nr_requeue,
> > @@ -2142,8 +2142,8 @@ static inline void queue_me(struct futex_q *q, struct futex_hash_bucket *hb)
> >   * be paired with exactly one earlier call to queue_me().
> >   *
> >   * Return:
> > - *   1 - if the futex_q was still queued (and we removed unqueued it);
> > - *   0 - if the futex_q was already removed by the waking thread
> > + *  - 1 - if the futex_q was still queued (and we removed unqueued it);
> > + *  - 0 - if the futex_q was already removed by the waking thread
> >   */
> >  static int unqueue_me(struct futex_q *q)
> >  {
> > @@ -2333,9 +2333,9 @@ static long futex_wait_restart(struct restart_block *restart);
> >   * acquire the lock. Must be called with the hb lock held.
> >   *
> >   * Return:
> > - *  1 - success, lock taken;
> > - *  0 - success, lock not taken;
> > - * <0 - on error (-EFAULT)
> > + *  -  1 - success, lock taken;
> > + *  -  0 - success, lock not taken;
> > + *  - <0 - on error (-EFAULT)
> >   */
> >  static int fixup_owner(u32 __user *uaddr, struct futex_q *q, int locked)
> >  {
> > @@ -2422,8 +2422,8 @@ static void futex_wait_queue_me(struct futex_hash_bucket *hb, struct futex_q *q,
> >   * with no q.key reference on failure.
> >   *
> >   * Return:
> > - *  0 - uaddr contains val and hb has been locked;
> > - * <1 - -EFAULT or -EWOULDBLOCK (uaddr does not contain val) and hb is unlocked
> > + *  -  0 - uaddr contains val and hb has been locked;
> > + *  - <1 - -EFAULT or -EWOULDBLOCK (uaddr does not contain val) and hb is unlocked
> >   */
> >  static int futex_wait_setup(u32 __user *uaddr, u32 val, unsigned int flags,
> >  			   struct futex_q *q, struct futex_hash_bucket **hb)
> > @@ -2895,8 +2895,8 @@ static int futex_unlock_pi(u32 __user *uaddr, unsigned int flags)
> >   * called with the hb lock held.
> >   *
> >   * Return:
> > - *  0 = no early wakeup detected;
> > - * <0 = -ETIMEDOUT or -ERESTARTNOINTR
> > + *  -  0 = no early wakeup detected;
> > + *  - <0 = -ETIMEDOUT or -ERESTARTNOINTR
> >   */
> >  static inline
> >  int handle_early_requeue_pi_wakeup(struct futex_hash_bucket *hb,
> > @@ -2968,8 +2968,8 @@ int handle_early_requeue_pi_wakeup(struct futex_hash_bucket *hb,
> >   * If 4 or 7, we cleanup and return with -ETIMEDOUT.
> >   *
> >   * Return:
> > - *  0 - On success;
> > - * <0 - On error
> > + *  -  0 - On success;
> > + *  - <0 - On error
> >   */
> >  static int futex_wait_requeue_pi(u32 __user *uaddr, unsigned int flags,
> >  				 u32 val, ktime_t *abs_time, u32 bitset,
> > diff --git a/kernel/locking/mutex.c b/kernel/locking/mutex.c
> > index 198527a62149..858a07590e39 100644
> > --- a/kernel/locking/mutex.c
> > +++ b/kernel/locking/mutex.c
> > @@ -227,9 +227,9 @@ static void __sched __mutex_lock_slowpath(struct mutex *lock);
> >   * (or statically defined) before it can be locked. memset()-ing
> >   * the mutex to 0 is not allowed.
> >   *
> > - * ( The CONFIG_DEBUG_MUTEXES .config option turns on debugging
> > - *   checks that will enforce the restrictions and will also do
> > - *   deadlock debugging. )
> > + * (The CONFIG_DEBUG_MUTEXES .config option turns on debugging
> > + * checks that will enforce the restrictions and will also do
> > + * deadlock debugging)
> >   *
> >   * This function is similar to (but not equivalent to) down().
> >   */
> > -- 
> > 2.9.3
> > 
> >   
> 




Cheers,
Mauro

[toc] | [prev] | [next] | [standalone]

#1642769 — Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST

From	Darren Hart <dvhart@infradead.org>
Date	2017-05-16 21:10 +0200
Subject	Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST
Message-ID	<tHQ14-157-15@gated-at.bofh.it>
In reply to	#1642730

On Tue, May 16, 2017 at 03:24:18PM -0300, Mauro Carvalho Chehab wrote:
> Em Tue, 16 May 2017 10:35:40 -0700
> Darren Hart <dvhart@infradead.org> escreveu:
> 
> > On Tue, May 16, 2017 at 09:15:56AM -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:
> > > 
> > > ./kernel/futex.c:492: WARNING: Inline emphasis start-string without end-string.
> > > ./kernel/futex.c:1264: WARNING: Block quote ends without a blank line; unexpected unindent.
> > > ./kernel/futex.c:1721: WARNING: Block quote ends without a blank line; unexpected unindent.
> > > ./kernel/futex.c:2338: WARNING: Block quote ends without a blank line; unexpected unindent.
> > > ./kernel/futex.c:2426: WARNING: Block quote ends without a blank line; unexpected unindent.
> > > ./kernel/futex.c:2899: WARNING: Block quote ends without a blank line; unexpected unindent.
> > > ./kernel/futex.c:2972: WARNING: Block quote ends without a blank line; unexpected unindent.
> > > 
> > > Fix them.
> > > 
> > > No functional changes.
> > > 
> > > Acked-by: Darren Hart (VMware) <dvhart@infradead.org>
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> > > ---  
> > 
> > 
> > What was the difference from v1? Quick scan didn't reveal anything obvious to
> > me... (context left intact in case you want to point it out inline), but just a
> > "Changes since v1" below the --- is always appreciated - even it it's "no
> > changes, new commit log".
> 
> From v1, the .. note:: got removed. That's pretty much the same version
> found on one of my replies + the addition of the warnings it produces
> without the patch.

Thanks Mauro. This still seems reasonable to me.

-- 
Darren Hart
VMware Open Source Technology Center

[toc] | [prev] | [next] | [standalone]

#1642518 — [PATCH v2 21/53] fs: add a blank lines on some kernel-doc comments

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:30 +0200
Subject	[PATCH v2 21/53] fs: add a blank lines on some kernel-doc comments
Message-ID	<tHJM0-5yL-65@gated-at.bofh.it>
In reply to	#1642478

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 functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 fs/fs-writeback.c | 12 +++++++-----
 fs/mpage.c        |  1 +
 fs/namei.c        |  1 +
 3 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/fs/fs-writeback.c b/fs/fs-writeback.c
index 63ee2940775c..8b426f83909f 100644
--- a/fs/fs-writeback.c
+++ b/fs/fs-writeback.c
@@ -2052,11 +2052,13 @@ static noinline void block_dump___mark_inode_dirty(struct inode *inode)
 }
 
 /**
- *	__mark_inode_dirty -	internal function
- *	@inode: inode to mark
- *	@flags: what kind of dirty (i.e. I_DIRTY_SYNC)
- *	Mark an inode as dirty. Callers should use mark_inode_dirty or
- *  	mark_inode_dirty_sync.
+ * __mark_inode_dirty -	internal function
+ *
+ * @inode: inode to mark
+ * @flags: what kind of dirty (i.e. I_DIRTY_SYNC)
+ *
+ * Mark an inode as dirty. Callers should use mark_inode_dirty or
+ * mark_inode_dirty_sync.
  *
  * Put the inode on the super block's dirty list.
  *
diff --git a/fs/mpage.c b/fs/mpage.c
index baff8f820c29..4760a0c09a4e 100644
--- a/fs/mpage.c
+++ b/fs/mpage.c
@@ -344,6 +344,7 @@ do_mpage_readpage(struct bio *bio, struct page *page, unsigned nr_pages,
  *
  * So an mpage read of the first 16 blocks of an ext2 file will cause I/O to be
  * submitted in the following order:
+ *
  * 	12 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16
  *
  * because the indirect block has to be read to get the mappings of blocks
diff --git a/fs/namei.c b/fs/namei.c
index 7286f87ce863..b5af8228e2d9 100644
--- a/fs/namei.c
+++ b/fs/namei.c
@@ -4300,6 +4300,7 @@ SYSCALL_DEFINE2(link, const char __user *, oldname, const char __user *, newname
  * The worst of all namespace operations - renaming directory. "Perverted"
  * doesn't even start to describe it. Somebody in UCB had a heck of a trip...
  * Problems:
+ *
  *	a) we can get into loop creation.
  *	b) race potential - two innocent renames can create a loop together.
  *	   That's where 4.4 screws up. Current fix: serialization on
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642519 — [PATCH v2 11/53] docs-rst: conf.py: sort LaTeX documents in alphabetical order

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:30 +0200
Subject	[PATCH v2 11/53] docs-rst: conf.py: sort LaTeX documents in alphabetical order
Message-ID	<tHJM0-5yL-69@gated-at.bofh.it>
In reply to	#1642478

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 <mchehab@s-opensource.com>
---
 Documentation/conf.py | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 1774357150a3..1bad6a4d6348 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -345,27 +345,28 @@ if major == 1 and minor > 3:
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
+# Sorted in alphabetical order
 latex_documents = [
-    ('doc-guide/index', 'kernel-doc-guide.tex', 'Linux Kernel Documentation Guide',
-     'The kernel development community', 'manual'),
     ('admin-guide/index', 'linux-user.tex', 'Linux Kernel User Documentation',
      'The kernel development community', 'manual'),
     ('core-api/index', 'core-api.tex', 'The kernel core API manual',
      'The kernel development community', 'manual'),
+    ('doc-guide/index', 'kernel-doc-guide.tex', 'Linux Kernel Documentation Guide',
+     'The kernel development community', 'manual'),
     ('driver-api/index', 'driver-api.tex', 'The kernel driver API manual',
      'The kernel development community', 'manual'),
+    ('gpu/index', 'gpu.tex', 'Linux GPU Driver Developer\'s Guide',
+     'The kernel development community', 'manual'),
     ('input/index', 'linux-input.tex', 'The Linux input driver subsystem',
      'The kernel development community', 'manual'),
     ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
      'The kernel development community', 'manual'),
     ('kernel-hacking/index', 'kernel-hacking.tex', 'Kernel Hacking Guides',
      'The kernel development community', 'manual'),
-    ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
-     'The kernel development community', 'manual'),
-    ('gpu/index', 'gpu.tex', 'Linux GPU Driver Developer\'s Guide',
-     'The kernel development community', 'manual'),
     ('media/index', 'media.tex', 'Linux Media Subsystem Documentation',
      'The kernel development community', 'manual'),
+    ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
+     'The kernel development community', 'manual'),
     ('security/index', 'security.tex', 'The kernel security subsystem manual',
      'The kernel development community', 'manual'),
 ]
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642521 — [PATCH v2 12/53] docs-rst: conf.py: remove kernel-documentation from LaTeX

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:30 +0200
Subject	[PATCH v2 12/53] docs-rst: conf.py: remove kernel-documentation from LaTeX
Message-ID	<tHJM0-5yL-75@gated-at.bofh.it>
In reply to	#1642478

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 <mchehab@s-opensource.com>
---
 Documentation/conf.py | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 1bad6a4d6348..15f34d6863a7 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -359,9 +359,7 @@ latex_documents = [
      'The kernel development community', 'manual'),
     ('input/index', 'linux-input.tex', 'The Linux input driver subsystem',
      'The kernel development community', 'manual'),
-    ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
-     'The kernel development community', 'manual'),
-    ('kernel-hacking/index', 'kernel-hacking.tex', 'Kernel Hacking Guides',
+    ('kernel-hacking/index', 'kernel-hacking.tex', 'Unreliable Guide To Hacking The Linux Kernel',
      'The kernel development community', 'manual'),
     ('media/index', 'media.tex', 'Linux Media Subsystem Documentation',
      'The kernel development community', 'manual'),
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642522 — [PATCH v2 43/53] docs: update old references for DocBook from the documentation

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:30 +0200
Subject	[PATCH v2 43/53] docs: update old references for DocBook from the documentation
Message-ID	<tHJM0-5yL-77@gated-at.bofh.it>
In reply to	#1642478

DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.

Acked-by: SeongJae Park <sj38.park@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/PCI/MSI-HOWTO.txt            |  2 +-
 Documentation/admin-guide/README.rst       |  6 ---
 Documentation/doc-guide/index.rst          |  1 -
 Documentation/doc-guide/sphinx.rst         |  5 ---
 Documentation/fb/api.txt                   |  4 +-
 Documentation/gpu/todo.rst                 |  2 +-
 Documentation/kernel-doc-nano-HOWTO.txt    | 65 +++++-------------------------
 Documentation/process/changes.rst          | 26 +++---------
 Documentation/process/howto.rst            |  8 ----
 Documentation/process/kernel-docs.rst      | 34 +---------------
 Documentation/translations/ja_JP/howto.rst |  7 ----
 Documentation/translations/ko_KR/howto.rst |  7 ----
 12 files changed, 21 insertions(+), 146 deletions(-)

diff --git a/Documentation/PCI/MSI-HOWTO.txt b/Documentation/PCI/MSI-HOWTO.txt
index 1e37138027a3..618e13d5e276 100644
--- a/Documentation/PCI/MSI-HOWTO.txt
+++ b/Documentation/PCI/MSI-HOWTO.txt
@@ -186,7 +186,7 @@ must disable interrupts while the lock is held.  If the device sends
 a different interrupt, the driver will deadlock trying to recursively
 acquire the spinlock.  Such deadlocks can be avoided by using
 spin_lock_irqsave() or spin_lock_irq() which disable local interrupts
-and acquire the lock (see Documentation/DocBook/kernel-locking).
+and acquire the lock (see Documentation/kernel-hacking/locking.rst).
 
 4.5 How to tell whether MSI/MSI-X is enabled on a device
 
diff --git a/Documentation/admin-guide/README.rst b/Documentation/admin-guide/README.rst
index b96e80f79e85..b5343c5aa224 100644
--- a/Documentation/admin-guide/README.rst
+++ b/Documentation/admin-guide/README.rst
@@ -55,12 +55,6 @@ Documentation
    contains information about the problems, which may result by upgrading
    your kernel.
 
- - The Documentation/DocBook/ subdirectory contains several guides for
-   kernel developers and users.  These guides can be rendered in a
-   number of formats:  PostScript (.ps), PDF, HTML, & man-pages, among others.
-   After installation, ``make psdocs``, ``make pdfdocs``, ``make htmldocs``,
-   or ``make mandocs`` will render the documentation in the requested format.
-
 Installing the kernel source
 ----------------------------
 
diff --git a/Documentation/doc-guide/index.rst b/Documentation/doc-guide/index.rst
index 6fff4024606e..a7f95d7d3a63 100644
--- a/Documentation/doc-guide/index.rst
+++ b/Documentation/doc-guide/index.rst
@@ -10,7 +10,6 @@ How to write kernel documentation
    sphinx.rst
    kernel-doc.rst
    parse-headers.rst
-   docbook.rst
 
 .. only::  subproject and html
 
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 731334de3efd..84e8e8a9cbdb 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -15,11 +15,6 @@ are used to describe the functions and types and design of the code. The
 kernel-doc comments have some special structure and formatting, but beyond that
 they are also treated as reStructuredText.
 
-There is also the deprecated DocBook toolchain to generate documentation from
-DocBook XML template files under ``Documentation/DocBook``. The DocBook files
-are to be converted to reStructuredText, and the toolchain is slated to be
-removed.
-
 Finally, there are thousands of plain text documentation files scattered around
 ``Documentation``. Some of these will likely be converted to reStructuredText
 over time, but the bulk of them will remain in plain text.
diff --git a/Documentation/fb/api.txt b/Documentation/fb/api.txt
index d4ff7de85700..d52cf1e3b975 100644
--- a/Documentation/fb/api.txt
+++ b/Documentation/fb/api.txt
@@ -289,12 +289,12 @@ the FB_CAP_FOURCC bit in the fb_fix_screeninfo capabilities field.
 FOURCC definitions are located in the linux/videodev2.h header. However, and
 despite starting with the V4L2_PIX_FMT_prefix, they are not restricted to V4L2
 and don't require usage of the V4L2 subsystem. FOURCC documentation is
-available in Documentation/DocBook/v4l/pixfmt.xml.
+available in Documentation/media/uapi/v4l/pixfmt.rst.
 
 To select a format, applications set the grayscale field to the desired FOURCC.
 For YUV formats, they should also select the appropriate colorspace by setting
 the colorspace field to one of the colorspaces listed in linux/videodev2.h and
-documented in Documentation/DocBook/v4l/colorspaces.xml.
+documented in Documentation/media/uapi/v4l/colorspaces.rst.
 
 The red, green, blue and transp fields are not used with the FOURCC-based API.
 For forward compatibility reasons applications must zero those fields, and
diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
index 1bdb7356a310..6162d0e9dc28 100644
--- a/Documentation/gpu/todo.rst
+++ b/Documentation/gpu/todo.rst
@@ -228,7 +228,7 @@ The DRM reference documentation is still lacking kerneldoc in a few areas. The
 task would be to clean up interfaces like moving functions around between
 files to better group them and improving the interfaces like dropping return
 values for functions that never fail. Then write kerneldoc for all exported
-functions and an overview section and integrate it all into the drm DocBook.
+functions and an overview section and integrate it all into the drm book.
 
 See https://dri.freedesktop.org/docs/drm/ for what's there already.
 
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
index 104740ea0041..c23e2c5ab80d 100644
--- a/Documentation/kernel-doc-nano-HOWTO.txt
+++ b/Documentation/kernel-doc-nano-HOWTO.txt
@@ -17,8 +17,8 @@ The format for this documentation is called the kernel-doc format.
 It is documented in this Documentation/kernel-doc-nano-HOWTO.txt file.
 
 This style embeds the documentation within the source files, using
-a few simple conventions.  The scripts/kernel-doc perl script, some
-SGML templates in Documentation/DocBook, and other tools understand
+a few simple conventions.  The scripts/kernel-doc perl script, the
+Documentation/sphinx/kerneldoc.py Sphinx extension and other tools understand
 these conventions, and are used to extract this embedded documentation
 into various documents.
 
@@ -122,15 +122,9 @@ are:
 - scripts/kernel-doc
 
   This is a perl script that hunts for the block comments and can mark
-  them up directly into DocBook, man, text, and HTML. (No, not
+  them up directly into DocBook, ReST, man, text, and HTML. (No, not
   texinfo.)
 
-- Documentation/DocBook/*.tmpl
-
-  These are SGML template files, which are normal SGML files with
-  special place-holders for where the extracted documentation should
-  go.
-
 - scripts/docproc.c
 
   This is a program for converting SGML template files into SGML
@@ -145,25 +139,18 @@ are:
 
 - Makefile
 
-  The targets 'xmldocs', 'psdocs', 'pdfdocs', and 'htmldocs' are used
-  to build XML DocBook files, PostScript files, PDF files, and html files
-  in Documentation/DocBook. The older target 'sgmldocs' is equivalent
-  to 'xmldocs'.
-
-- Documentation/DocBook/Makefile
-
-  This is where C files are associated with SGML templates.
-
+  The targets 'xmldocs', 'latexdocs', 'pdfdocs', 'epubdocs'and 'htmldocs'
+  are used to build XML DocBook files, LaTeX files, PDF files,
+  ePub files and html files in Documentation/.
 
 How to extract the documentation
 --------------------------------
 
 If you just want to read the ready-made books on the various
-subsystems (see Documentation/DocBook/*.tmpl), just type 'make
-psdocs', or 'make pdfdocs', or 'make htmldocs', depending on your
-preference.  If you would rather read a different format, you can type
-'make xmldocs' and then use DocBook tools to convert
-Documentation/DocBook/*.xml to a format of your choice (for example,
+subsystems, just type 'make epubdocs', or 'make pdfdocs', or 'make htmldocs',
+depending on your preference.  If you would rather read a different format,
+you can type 'make xmldocs' and then use DocBook tools to convert
+Documentation/output/*.xml to a format of your choice (for example,
 'db2html ...' if 'make htmldocs' was not defined).
 
 If you want to see man pages instead, you can do this:
@@ -329,37 +316,7 @@ This is done by using a DOC: section keyword with a section title.  E.g.:
  * hardware, software, or its subject(s).
  */
 
-DOC: sections are used in SGML templates files as indicated below.
-
-
-How to make new SGML template files
------------------------------------
-
-SGML template files (*.tmpl) are like normal SGML files, except that
-they can contain escape sequences where extracted documentation should
-be inserted.
-
-!E<filename> is replaced by the documentation, in <filename>, for
-functions that are exported using EXPORT_SYMBOL: the function list is
-collected from files listed in Documentation/DocBook/Makefile.
-
-!I<filename> is replaced by the documentation for functions that are
-_not_ exported using EXPORT_SYMBOL.
-
-!D<filename> is used to name additional files to search for functions
-exported using EXPORT_SYMBOL.
-
-!F<filename> <function [functions...]> is replaced by the
-documentation, in <filename>, for the functions listed.
-
-!P<filename> <section title> is replaced by the contents of the DOC:
-section titled <section title> from <filename>.
-Spaces are allowed in <section title>; do not quote the <section title>.
-
-!C<filename> is replaced by nothing, but makes the tools check that
-all DOC: sections and documented functions, symbols, etc. are used.
-This makes sense to use when you use !F/!P only and want to verify
-that all documentation is included.
+DOC: sections are used in ReST files.
 
 Tim.
 */ <twaugh@redhat.com>
diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index e25d63f8c0da..3aed751e0cb5 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -116,12 +116,11 @@ DevFS has been obsoleted in favour of udev
 
 Linux documentation for functions is transitioning to inline
 documentation via specially-formatted comments near their
-definitions in the source.  These comments can be combined with the
-SGML templates in the Documentation/DocBook directory to make DocBook
-files, which can then be converted by DocBook stylesheets to PostScript,
-HTML, PDF files, and several other formats.  In order to convert from
-DocBook format to a format of your choice, you'll need to install Jade as
-well as the desired DocBook stylesheets.
+definitions in the source.  These comments can be combined with ReST
+files the Documentation/ directory to make enriched documentation, which can
+then be converted to PostScript, HTML, LaTex, ePUB and PDF files.
+In order to convert from ReST format to a format of your choice, you'll need
+Sphinx.
 
 Util-linux
 ----------
@@ -323,12 +322,6 @@ PDF outputs, it is recommended to use version 1.4.6.
   functionalities required for ``XeLaTex`` to work. For PDF output you'll also
   need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).
 
-Other tools
------------
-
-In order to produce documentation from DocBook, you'll also need ``xmlto``.
-Please notice, however, that we're currently migrating all documents to use
-``Sphinx``.
 
 Getting updated software
 ========================
@@ -409,15 +402,6 @@ Quota-tools
 
 - <http://sourceforge.net/projects/linuxquota/>
 
-DocBook Stylesheets
--------------------
-
-- <http://sourceforge.net/projects/docbook/files/docbook-dsssl/>
-
-XMLTO XSLT Frontend
--------------------
-
-- <http://cyberelk.net/tim/xmlto/>
 
 Intel P6 microcode
 ------------------
diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst
index 1260f60d4cb9..c6875b1db56f 100644
--- a/Documentation/process/howto.rst
+++ b/Documentation/process/howto.rst
@@ -180,14 +180,6 @@ They can also be generated on LaTeX and ePub formats with::
 	make latexdocs
 	make epubdocs
 
-Currently, there are some documents written on DocBook that are in
-the process of conversion to ReST. Such documents will be created in the
-Documentation/DocBook/ directory and can be generated also as
-Postscript or man pages by running::
-
-	make psdocs
-	make mandocs
-
 Becoming A Kernel Developer
 ---------------------------
 
diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
index 05a7857a4a83..b8cac85a4001 100644
--- a/Documentation/process/kernel-docs.rst
+++ b/Documentation/process/kernel-docs.rst
@@ -40,50 +40,18 @@ Enjoy!
 Docs at the Linux Kernel tree
 -----------------------------
 
-The DocBook books should be built with ``make {htmldocs | psdocs | pdfdocs}``.
 The Sphinx books should be built with ``make {htmldocs | pdfdocs | epubdocs}``.
 
     * Name: **linux/Documentation**
 
       :Author: Many.
       :Location: Documentation/
-      :Keywords: text files, Sphinx, DocBook.
+      :Keywords: text files, Sphinx.
       :Description: Documentation that comes with the kernel sources,
         inside the Documentation directory. Some pages from this document
         (including this document itself) have been moved there, and might
         be more up to date than the web version.
 
-    * Title: **The Kernel Hacking HOWTO**
-
-      :Author: Various Talented People, and Rusty.
-      :Location: Documentation/DocBook/kernel-hacking.tmpl
-      :Keywords: HOWTO, kernel contexts, deadlock, locking, modules,
-        symbols, return conventions.
-      :Description: From the Introduction: "Please understand that I
-        never wanted to write this document, being grossly underqualified,
-        but I always wanted to read it, and this was the only way. I
-        simply explain some best practices, and give reading entry-points
-        into the kernel sources. I avoid implementation details: that's
-        what the code is for, and I ignore whole tracts of useful
-        routines. This document assumes familiarity with C, and an
-        understanding of what the kernel is, and how it is used. It was
-        originally written for the 2.3 kernels, but nearly all of it
-        applies to 2.2 too; 2.0 is slightly different".
-
-    * Title: **Linux Kernel Locking HOWTO**
-
-      :Author: Various Talented People, and Rusty.
-      :Location: Documentation/DocBook/kernel-locking.tmpl
-      :Keywords: locks, locking, spinlock, semaphore, atomic, race
-        condition, bottom halves, tasklets, softirqs.
-      :Description: The title says it all: document describing the
-        locking system in the Linux Kernel either in uniprocessor or SMP
-        systems.
-      :Notes: "It was originally written for the later (>2.3.47) 2.3
-        kernels, but most of it applies to 2.2 too; 2.0 is slightly
-        different". Freely redistributable under the conditions of the GNU
-        General Public License.
-
 On-line docs
 ------------
 
diff --git a/Documentation/translations/ja_JP/howto.rst b/Documentation/translations/ja_JP/howto.rst
index 4511eed0fabb..8d7ed0cbbf5f 100644
--- a/Documentation/translations/ja_JP/howto.rst
+++ b/Documentation/translations/ja_JP/howto.rst
@@ -197,13 +197,6 @@ ReSTマークアップを使ったドキュメントは Documentation/outputに
         make latexdocs
         make epubdocs
 
-現在、幾つかの DocBook形式で書かれたドキュメントは ReST形式に転換中で
-す。それらのドキュメントはDocumentation/DocBook ディレクトリに生成され、
-Postscript または man ページの形式を生成するには以下のようにします - ::
-
-        make psdocs
-        make mandocs
-
 カーネル開発者になるには
 ------------------------
 
diff --git a/Documentation/translations/ko_KR/howto.rst b/Documentation/translations/ko_KR/howto.rst
index 2333697251dd..f06de9ca41a4 100644
--- a/Documentation/translations/ko_KR/howto.rst
+++ b/Documentation/translations/ko_KR/howto.rst
@@ -191,13 +191,6 @@ ReST 마크업을 사용하는 문서들은 Documentation/output 에 생성된
          make latexdocs
          make epubdocs
 
-현재, ReST 로의 변환이 진행중인, DocBook 으로 쓰인 문서들이 존재한다. 그런
-문서들은 Documentation/DocBook/ 디렉토리 안에 생성될 것이고 다음 커맨드를 통해
-Postscript 나 man page 로도 만들어질 수 있다::
-
-         make psdocs
-         make mandocs
-
 커널 개발자가 되는 것
 ---------------------
 
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1643517 — Re: [PATCH v2 43/53] docs: update old references for DocBook from the documentation

From	Bjorn Helgaas <helgaas@kernel.org>
Date	2017-05-17 19:00 +0200
Subject	Re: [PATCH v2 43/53] docs: update old references for DocBook from the documentation
Message-ID	<tIasO-5zp-17@gated-at.bofh.it>
In reply to	#1642522

On Tue, May 16, 2017 at 09:16:35AM -0300, Mauro Carvalho Chehab wrote:
> DocBook is mentioned several times at the documentation. Update
> the obsolete references from it at the DocBook.
> 
> Acked-by: SeongJae Park <sj38.park@gmail.com>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Acked-by: Bjorn Helgaas <bhelgaas@google.com>	# for PCI/MSI-HOWTO.txt

> ---
>  Documentation/PCI/MSI-HOWTO.txt            |  2 +-
>  Documentation/admin-guide/README.rst       |  6 ---
>  Documentation/doc-guide/index.rst          |  1 -
>  Documentation/doc-guide/sphinx.rst         |  5 ---
>  Documentation/fb/api.txt                   |  4 +-
>  Documentation/gpu/todo.rst                 |  2 +-
>  Documentation/kernel-doc-nano-HOWTO.txt    | 65 +++++-------------------------
>  Documentation/process/changes.rst          | 26 +++---------
>  Documentation/process/howto.rst            |  8 ----
>  Documentation/process/kernel-docs.rst      | 34 +---------------
>  Documentation/translations/ja_JP/howto.rst |  7 ----
>  Documentation/translations/ko_KR/howto.rst |  7 ----
>  12 files changed, 21 insertions(+), 146 deletions(-)
> 
> diff --git a/Documentation/PCI/MSI-HOWTO.txt b/Documentation/PCI/MSI-HOWTO.txt
> index 1e37138027a3..618e13d5e276 100644
> --- a/Documentation/PCI/MSI-HOWTO.txt
> +++ b/Documentation/PCI/MSI-HOWTO.txt
> @@ -186,7 +186,7 @@ must disable interrupts while the lock is held.  If the device sends
>  a different interrupt, the driver will deadlock trying to recursively
>  acquire the spinlock.  Such deadlocks can be avoided by using
>  spin_lock_irqsave() or spin_lock_irq() which disable local interrupts
> -and acquire the lock (see Documentation/DocBook/kernel-locking).
> +and acquire the lock (see Documentation/kernel-hacking/locking.rst).
>  
>  4.5 How to tell whether MSI/MSI-X is enabled on a device
>  
> diff --git a/Documentation/admin-guide/README.rst b/Documentation/admin-guide/README.rst
> index b96e80f79e85..b5343c5aa224 100644
> --- a/Documentation/admin-guide/README.rst
> +++ b/Documentation/admin-guide/README.rst
> @@ -55,12 +55,6 @@ Documentation
>     contains information about the problems, which may result by upgrading
>     your kernel.
>  
> - - The Documentation/DocBook/ subdirectory contains several guides for
> -   kernel developers and users.  These guides can be rendered in a
> -   number of formats:  PostScript (.ps), PDF, HTML, & man-pages, among others.
> -   After installation, ``make psdocs``, ``make pdfdocs``, ``make htmldocs``,
> -   or ``make mandocs`` will render the documentation in the requested format.
> -
>  Installing the kernel source
>  ----------------------------
>  
> diff --git a/Documentation/doc-guide/index.rst b/Documentation/doc-guide/index.rst
> index 6fff4024606e..a7f95d7d3a63 100644
> --- a/Documentation/doc-guide/index.rst
> +++ b/Documentation/doc-guide/index.rst
> @@ -10,7 +10,6 @@ How to write kernel documentation
>     sphinx.rst
>     kernel-doc.rst
>     parse-headers.rst
> -   docbook.rst
>  
>  .. only::  subproject and html
>  
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index 731334de3efd..84e8e8a9cbdb 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -15,11 +15,6 @@ are used to describe the functions and types and design of the code. The
>  kernel-doc comments have some special structure and formatting, but beyond that
>  they are also treated as reStructuredText.
>  
> -There is also the deprecated DocBook toolchain to generate documentation from
> -DocBook XML template files under ``Documentation/DocBook``. The DocBook files
> -are to be converted to reStructuredText, and the toolchain is slated to be
> -removed.
> -
>  Finally, there are thousands of plain text documentation files scattered around
>  ``Documentation``. Some of these will likely be converted to reStructuredText
>  over time, but the bulk of them will remain in plain text.
> diff --git a/Documentation/fb/api.txt b/Documentation/fb/api.txt
> index d4ff7de85700..d52cf1e3b975 100644
> --- a/Documentation/fb/api.txt
> +++ b/Documentation/fb/api.txt
> @@ -289,12 +289,12 @@ the FB_CAP_FOURCC bit in the fb_fix_screeninfo capabilities field.
>  FOURCC definitions are located in the linux/videodev2.h header. However, and
>  despite starting with the V4L2_PIX_FMT_prefix, they are not restricted to V4L2
>  and don't require usage of the V4L2 subsystem. FOURCC documentation is
> -available in Documentation/DocBook/v4l/pixfmt.xml.
> +available in Documentation/media/uapi/v4l/pixfmt.rst.
>  
>  To select a format, applications set the grayscale field to the desired FOURCC.
>  For YUV formats, they should also select the appropriate colorspace by setting
>  the colorspace field to one of the colorspaces listed in linux/videodev2.h and
> -documented in Documentation/DocBook/v4l/colorspaces.xml.
> +documented in Documentation/media/uapi/v4l/colorspaces.rst.
>  
>  The red, green, blue and transp fields are not used with the FOURCC-based API.
>  For forward compatibility reasons applications must zero those fields, and
> diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
> index 1bdb7356a310..6162d0e9dc28 100644
> --- a/Documentation/gpu/todo.rst
> +++ b/Documentation/gpu/todo.rst
> @@ -228,7 +228,7 @@ The DRM reference documentation is still lacking kerneldoc in a few areas. The
>  task would be to clean up interfaces like moving functions around between
>  files to better group them and improving the interfaces like dropping return
>  values for functions that never fail. Then write kerneldoc for all exported
> -functions and an overview section and integrate it all into the drm DocBook.
> +functions and an overview section and integrate it all into the drm book.
>  
>  See https://dri.freedesktop.org/docs/drm/ for what's there already.
>  
> diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
> index 104740ea0041..c23e2c5ab80d 100644
> --- a/Documentation/kernel-doc-nano-HOWTO.txt
> +++ b/Documentation/kernel-doc-nano-HOWTO.txt
> @@ -17,8 +17,8 @@ The format for this documentation is called the kernel-doc format.
>  It is documented in this Documentation/kernel-doc-nano-HOWTO.txt file.
>  
>  This style embeds the documentation within the source files, using
> -a few simple conventions.  The scripts/kernel-doc perl script, some
> -SGML templates in Documentation/DocBook, and other tools understand
> +a few simple conventions.  The scripts/kernel-doc perl script, the
> +Documentation/sphinx/kerneldoc.py Sphinx extension and other tools understand
>  these conventions, and are used to extract this embedded documentation
>  into various documents.
>  
> @@ -122,15 +122,9 @@ are:
>  - scripts/kernel-doc
>  
>    This is a perl script that hunts for the block comments and can mark
> -  them up directly into DocBook, man, text, and HTML. (No, not
> +  them up directly into DocBook, ReST, man, text, and HTML. (No, not
>    texinfo.)
>  
> -- Documentation/DocBook/*.tmpl
> -
> -  These are SGML template files, which are normal SGML files with
> -  special place-holders for where the extracted documentation should
> -  go.
> -
>  - scripts/docproc.c
>  
>    This is a program for converting SGML template files into SGML
> @@ -145,25 +139,18 @@ are:
>  
>  - Makefile
>  
> -  The targets 'xmldocs', 'psdocs', 'pdfdocs', and 'htmldocs' are used
> -  to build XML DocBook files, PostScript files, PDF files, and html files
> -  in Documentation/DocBook. The older target 'sgmldocs' is equivalent
> -  to 'xmldocs'.
> -
> -- Documentation/DocBook/Makefile
> -
> -  This is where C files are associated with SGML templates.
> -
> +  The targets 'xmldocs', 'latexdocs', 'pdfdocs', 'epubdocs'and 'htmldocs'
> +  are used to build XML DocBook files, LaTeX files, PDF files,
> +  ePub files and html files in Documentation/.
>  
>  How to extract the documentation
>  --------------------------------
>  
>  If you just want to read the ready-made books on the various
> -subsystems (see Documentation/DocBook/*.tmpl), just type 'make
> -psdocs', or 'make pdfdocs', or 'make htmldocs', depending on your
> -preference.  If you would rather read a different format, you can type
> -'make xmldocs' and then use DocBook tools to convert
> -Documentation/DocBook/*.xml to a format of your choice (for example,
> +subsystems, just type 'make epubdocs', or 'make pdfdocs', or 'make htmldocs',
> +depending on your preference.  If you would rather read a different format,
> +you can type 'make xmldocs' and then use DocBook tools to convert
> +Documentation/output/*.xml to a format of your choice (for example,
>  'db2html ...' if 'make htmldocs' was not defined).
>  
>  If you want to see man pages instead, you can do this:
> @@ -329,37 +316,7 @@ This is done by using a DOC: section keyword with a section title.  E.g.:
>   * hardware, software, or its subject(s).
>   */
>  
> -DOC: sections are used in SGML templates files as indicated below.
> -
> -
> -How to make new SGML template files
> ------------------------------------
> -
> -SGML template files (*.tmpl) are like normal SGML files, except that
> -they can contain escape sequences where extracted documentation should
> -be inserted.
> -
> -!E<filename> is replaced by the documentation, in <filename>, for
> -functions that are exported using EXPORT_SYMBOL: the function list is
> -collected from files listed in Documentation/DocBook/Makefile.
> -
> -!I<filename> is replaced by the documentation for functions that are
> -_not_ exported using EXPORT_SYMBOL.
> -
> -!D<filename> is used to name additional files to search for functions
> -exported using EXPORT_SYMBOL.
> -
> -!F<filename> <function [functions...]> is replaced by the
> -documentation, in <filename>, for the functions listed.
> -
> -!P<filename> <section title> is replaced by the contents of the DOC:
> -section titled <section title> from <filename>.
> -Spaces are allowed in <section title>; do not quote the <section title>.
> -
> -!C<filename> is replaced by nothing, but makes the tools check that
> -all DOC: sections and documented functions, symbols, etc. are used.
> -This makes sense to use when you use !F/!P only and want to verify
> -that all documentation is included.
> +DOC: sections are used in ReST files.
>  
>  Tim.
>  */ <twaugh@redhat.com>
> diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> index e25d63f8c0da..3aed751e0cb5 100644
> --- a/Documentation/process/changes.rst
> +++ b/Documentation/process/changes.rst
> @@ -116,12 +116,11 @@ DevFS has been obsoleted in favour of udev
>  
>  Linux documentation for functions is transitioning to inline
>  documentation via specially-formatted comments near their
> -definitions in the source.  These comments can be combined with the
> -SGML templates in the Documentation/DocBook directory to make DocBook
> -files, which can then be converted by DocBook stylesheets to PostScript,
> -HTML, PDF files, and several other formats.  In order to convert from
> -DocBook format to a format of your choice, you'll need to install Jade as
> -well as the desired DocBook stylesheets.
> +definitions in the source.  These comments can be combined with ReST
> +files the Documentation/ directory to make enriched documentation, which can
> +then be converted to PostScript, HTML, LaTex, ePUB and PDF files.
> +In order to convert from ReST format to a format of your choice, you'll need
> +Sphinx.
>  
>  Util-linux
>  ----------
> @@ -323,12 +322,6 @@ PDF outputs, it is recommended to use version 1.4.6.
>    functionalities required for ``XeLaTex`` to work. For PDF output you'll also
>    need ``convert(1)`` from ImageMagick (https://www.imagemagick.org).
>  
> -Other tools
> ------------
> -
> -In order to produce documentation from DocBook, you'll also need ``xmlto``.
> -Please notice, however, that we're currently migrating all documents to use
> -``Sphinx``.
>  
>  Getting updated software
>  ========================
> @@ -409,15 +402,6 @@ Quota-tools
>  
>  - <http://sourceforge.net/projects/linuxquota/>
>  
> -DocBook Stylesheets
> --------------------
> -
> -- <http://sourceforge.net/projects/docbook/files/docbook-dsssl/>
> -
> -XMLTO XSLT Frontend
> --------------------
> -
> -- <http://cyberelk.net/tim/xmlto/>
>  
>  Intel P6 microcode
>  ------------------
> diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst
> index 1260f60d4cb9..c6875b1db56f 100644
> --- a/Documentation/process/howto.rst
> +++ b/Documentation/process/howto.rst
> @@ -180,14 +180,6 @@ They can also be generated on LaTeX and ePub formats with::
>  	make latexdocs
>  	make epubdocs
>  
> -Currently, there are some documents written on DocBook that are in
> -the process of conversion to ReST. Such documents will be created in the
> -Documentation/DocBook/ directory and can be generated also as
> -Postscript or man pages by running::
> -
> -	make psdocs
> -	make mandocs
> -
>  Becoming A Kernel Developer
>  ---------------------------
>  
> diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
> index 05a7857a4a83..b8cac85a4001 100644
> --- a/Documentation/process/kernel-docs.rst
> +++ b/Documentation/process/kernel-docs.rst
> @@ -40,50 +40,18 @@ Enjoy!
>  Docs at the Linux Kernel tree
>  -----------------------------
>  
> -The DocBook books should be built with ``make {htmldocs | psdocs | pdfdocs}``.
>  The Sphinx books should be built with ``make {htmldocs | pdfdocs | epubdocs}``.
>  
>      * Name: **linux/Documentation**
>  
>        :Author: Many.
>        :Location: Documentation/
> -      :Keywords: text files, Sphinx, DocBook.
> +      :Keywords: text files, Sphinx.
>        :Description: Documentation that comes with the kernel sources,
>          inside the Documentation directory. Some pages from this document
>          (including this document itself) have been moved there, and might
>          be more up to date than the web version.
>  
> -    * Title: **The Kernel Hacking HOWTO**
> -
> -      :Author: Various Talented People, and Rusty.
> -      :Location: Documentation/DocBook/kernel-hacking.tmpl
> -      :Keywords: HOWTO, kernel contexts, deadlock, locking, modules,
> -        symbols, return conventions.
> -      :Description: From the Introduction: "Please understand that I
> -        never wanted to write this document, being grossly underqualified,
> -        but I always wanted to read it, and this was the only way. I
> -        simply explain some best practices, and give reading entry-points
> -        into the kernel sources. I avoid implementation details: that's
> -        what the code is for, and I ignore whole tracts of useful
> -        routines. This document assumes familiarity with C, and an
> -        understanding of what the kernel is, and how it is used. It was
> -        originally written for the 2.3 kernels, but nearly all of it
> -        applies to 2.2 too; 2.0 is slightly different".
> -
> -    * Title: **Linux Kernel Locking HOWTO**
> -
> -      :Author: Various Talented People, and Rusty.
> -      :Location: Documentation/DocBook/kernel-locking.tmpl
> -      :Keywords: locks, locking, spinlock, semaphore, atomic, race
> -        condition, bottom halves, tasklets, softirqs.
> -      :Description: The title says it all: document describing the
> -        locking system in the Linux Kernel either in uniprocessor or SMP
> -        systems.
> -      :Notes: "It was originally written for the later (>2.3.47) 2.3
> -        kernels, but most of it applies to 2.2 too; 2.0 is slightly
> -        different". Freely redistributable under the conditions of the GNU
> -        General Public License.
> -
>  On-line docs
>  ------------
>  
> diff --git a/Documentation/translations/ja_JP/howto.rst b/Documentation/translations/ja_JP/howto.rst
> index 4511eed0fabb..8d7ed0cbbf5f 100644
> --- a/Documentation/translations/ja_JP/howto.rst
> +++ b/Documentation/translations/ja_JP/howto.rst
> @@ -197,13 +197,6 @@ ReSTマークアップを使ったドキュメントは Documentation/outputに
>          make latexdocs
>          make epubdocs
>  
> -現在、幾つかの DocBook形式で書かれたドキュメントは ReST形式に転換中で
> -す。それらのドキュメントはDocumentation/DocBook ディレクトリに生成され、
> -Postscript または man ページの形式を生成するには以下のようにします - ::
> -
> -        make psdocs
> -        make mandocs
> -
>  カーネル開発者になるには
>  ------------------------
>  
> diff --git a/Documentation/translations/ko_KR/howto.rst b/Documentation/translations/ko_KR/howto.rst
> index 2333697251dd..f06de9ca41a4 100644
> --- a/Documentation/translations/ko_KR/howto.rst
> +++ b/Documentation/translations/ko_KR/howto.rst
> @@ -191,13 +191,6 @@ ReST 마크업을 사용하는 문서들은 Documentation/output 에 생성된
>           make latexdocs
>           make epubdocs
>  
> -현재, ReST 로의 변환이 진행중인, DocBook 으로 쓰인 문서들이 존재한다. 그런
> -문서들은 Documentation/DocBook/ 디렉토리 안에 생성될 것이고 다음 커맨드를 통해
> -Postscript 나 man page 로도 만들어질 수 있다::
> -
> -         make psdocs
> -         make mandocs
> -
>  커널 개발자가 되는 것
>  ---------------------
>  
> -- 
> 2.9.3
>

[toc] | [prev] | [next] | [standalone]

#1642524 — [PATCH v2 13/53] docs-rst: add crypto API book to pdf output

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:40 +0200
Subject	[PATCH v2 13/53] docs-rst: add crypto API book to pdf output
Message-ID	<tHJVD-5BS-5@gated-at.bofh.it>
In reply to	#1642478

The crypto API book was added without the bits required to
generate PDF output. Add them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/conf.py        |  2 ++
 Documentation/crypto/conf.py | 10 ++++++++++
 2 files changed, 12 insertions(+)
 create mode 100644 Documentation/crypto/conf.py

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 15f34d6863a7..ce62723491d4 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -351,6 +351,8 @@ latex_documents = [
      'The kernel development community', 'manual'),
     ('core-api/index', 'core-api.tex', 'The kernel core API manual',
      'The kernel development community', 'manual'),
+    ('crypto/index', 'crypto-api.tex', 'Linux Kernel Crypto API manual',
+     'The kernel development community', 'manual'),
     ('doc-guide/index', 'kernel-doc-guide.tex', 'Linux Kernel Documentation Guide',
      'The kernel development community', 'manual'),
     ('driver-api/index', 'driver-api.tex', 'The kernel driver API manual',
diff --git a/Documentation/crypto/conf.py b/Documentation/crypto/conf.py
new file mode 100644
index 000000000000..4335d251ddf3
--- /dev/null
+++ b/Documentation/crypto/conf.py
@@ -0,0 +1,10 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = 'Linux Kernel Crypto API'
+
+tags.add("subproject")
+
+latex_documents = [
+    ('index', 'crypto-api.tex', 'Linux Kernel Crypto API manual',
+     'The kernel development community', 'manual'),
+]
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642526 — [PATCH v2 22/53] fs: eventfd: fix identation on kernel-doc

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:40 +0200
Subject	[PATCH v2 22/53] fs: eventfd: fix identation on kernel-doc
Message-ID	<tHJVD-5BS-19@gated-at.bofh.it>
In reply to	#1642478

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 <mchehab@s-opensource.com>
---
 fs/eventfd.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/fs/eventfd.c b/fs/eventfd.c
index 68b9fffcb2c8..beac8175de19 100644
--- a/fs/eventfd.c
+++ b/fs/eventfd.c
@@ -215,8 +215,8 @@ EXPORT_SYMBOL_GPL(eventfd_ctx_remove_wait_queue);
  *
  * Returns %0 if successful, or the following error codes:
  *
- * -EAGAIN      : The operation would have blocked but @no_wait was non-zero.
- * -ERESTARTSYS : A signal interrupted the wait operation.
+ *  - -EAGAIN      : The operation would have blocked but @no_wait was non-zero.
+ *  - -ERESTARTSYS : A signal interrupted the wait operation.
  *
  * If @no_wait is zero, the function might sleep until the eventfd internal
  * counter becomes greater than zero.
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642528 — [PATCH v2 35/53] docs-rst: convert rapidio book to ReST

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:40 +0200
Subject	[PATCH v2 35/53] docs-rst: convert rapidio book to ReST
Message-ID	<tHJVD-5BS-17@gated-at.bofh.it>
In reply to	#1642478

Use pandoc to convert documentation to ReST by calling
Documentation/sphinx/tmplcvt script.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/DocBook/Makefile       |   4 +-
 Documentation/DocBook/rapidio.tmpl   | 155 -----------------------------------
 Documentation/driver-api/index.rst   |   1 +
 Documentation/driver-api/rapidio.rst | 107 ++++++++++++++++++++++++
 4 files changed, 110 insertions(+), 157 deletions(-)
 delete mode 100644 Documentation/DocBook/rapidio.tmpl
 create mode 100644 Documentation/driver-api/rapidio.rst

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index 3bbda02d6aee..baedb14f3b40 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -8,8 +8,8 @@
 
 DOCBOOKS := \
 	    lsm.xml \
-	    mtdnand.xml librs.xml rapidio.xml \
-	    sh.xml w1.xml
+	    mtdnand.xml librs.xml \
+	    sh.xml
 
 ifeq ($(DOCBOOKS),)
 
diff --git a/Documentation/DocBook/rapidio.tmpl b/Documentation/DocBook/rapidio.tmpl
deleted file mode 100644
index ac3cca3399a1..000000000000
--- a/Documentation/DocBook/rapidio.tmpl
+++ /dev/null
@@ -1,155 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-        "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-	<!ENTITY rapidio SYSTEM "rapidio.xml">
-	]>
-
-<book id="RapidIO-Guide">
- <bookinfo>
-  <title>RapidIO Subsystem Guide</title>
-
-  <authorgroup>
-   <author>
-    <firstname>Matt</firstname>
-    <surname>Porter</surname>
-    <affiliation>
-     <address>
-      <email>mporter@kernel.crashing.org</email>
-      <email>mporter@mvista.com</email>
-     </address>
-    </affiliation>
-   </author>
-  </authorgroup>
-
-  <copyright>
-   <year>2005</year>
-   <holder>MontaVista Software, Inc.</holder>
-  </copyright>
-
-  <legalnotice>
-   <para>
-     This documentation is free software; you can redistribute
-     it and/or modify it under the terms of the GNU General Public
-     License version 2 as published by the Free Software Foundation.
-   </para>
-
-   <para>
-     This program is distributed in the hope that it will be
-     useful, but WITHOUT ANY WARRANTY; without even the implied
-     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-     See the GNU General Public License for more details.
-   </para>
-
-   <para>
-     You should have received a copy of the GNU General Public
-     License along with this program; if not, write to the Free
-     Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
-     MA 02111-1307 USA
-   </para>
-
-   <para>
-     For more details see the file COPYING in the source
-     distribution of Linux.
-   </para>
-  </legalnotice>
- </bookinfo>
-
-<toc></toc>
-
-  <chapter id="intro">
-      <title>Introduction</title>
-  <para>
-	RapidIO is a high speed switched fabric interconnect with
-	features aimed at the embedded market.  RapidIO provides
-	support for memory-mapped I/O as well as message-based
-	transactions over the switched fabric network. RapidIO has
-	a standardized discovery mechanism not unlike the PCI bus
-	standard that allows simple detection of devices in a
-	network.
-  </para>
-  <para>
-  	This documentation is provided for developers intending
-	to support RapidIO on new architectures, write new drivers,
-	or to understand the subsystem internals.
-  </para>
-  </chapter>
-
-  <chapter id="bugs">
-     <title>Known Bugs and Limitations</title>
-
-     <sect1 id="known_bugs">
-     	<title>Bugs</title>
-	  <para>None. ;)</para>
-     </sect1>
-     <sect1 id="Limitations">
-     	<title>Limitations</title>
-	  <para>
-	    <orderedlist>
-	      <listitem><para>Access/management of RapidIO memory regions is not supported</para></listitem>
-	      <listitem><para>Multiple host enumeration is not supported</para></listitem>
-	    </orderedlist>
-	 </para>
-     </sect1>
-  </chapter>
-
-  <chapter id="drivers">
-     	<title>RapidIO driver interface</title>
-	<para>
-		Drivers are provided a set of calls in order
-		to interface with the subsystem to gather info
-		on devices, request/map memory region resources,
-		and manage mailboxes/doorbells.
-	</para>
-	<sect1 id="Functions">
-		<title>Functions</title>
-!Iinclude/linux/rio_drv.h
-!Edrivers/rapidio/rio-driver.c
-!Edrivers/rapidio/rio.c
-	</sect1>
-  </chapter>
-
-  <chapter id="internals">
-     <title>Internals</title>
-
-     <para>
-     This chapter contains the autogenerated documentation of the RapidIO
-     subsystem.
-     </para>
-
-     <sect1 id="Structures"><title>Structures</title>
-!Iinclude/linux/rio.h
-     </sect1>
-     <sect1 id="Enumeration_and_Discovery"><title>Enumeration and Discovery</title>
-!Idrivers/rapidio/rio-scan.c
-     </sect1>
-     <sect1 id="Driver_functionality"><title>Driver functionality</title>
-!Idrivers/rapidio/rio.c
-!Idrivers/rapidio/rio-access.c
-     </sect1>
-     <sect1 id="Device_model_support"><title>Device model support</title>
-!Idrivers/rapidio/rio-driver.c
-     </sect1>
-     <sect1 id="PPC32_support"><title>PPC32 support</title>
-!Iarch/powerpc/sysdev/fsl_rio.c
-     </sect1>
-  </chapter>
-
-  <chapter id="credits">
-     <title>Credits</title>
-	<para>
-		The following people have contributed to the RapidIO
-		subsystem directly or indirectly:
-		<orderedlist>
-			<listitem><para>Matt Porter<email>mporter@kernel.crashing.org</email></para></listitem>
-			<listitem><para>Randy Vinson<email>rvinson@mvista.com</email></para></listitem>
-			<listitem><para>Dan Malek<email>dan@embeddedalley.com</email></para></listitem>
-		</orderedlist>
-	</para>
-	<para>
-		The following people have contributed to this document:
-		<orderedlist>
-			<listitem><para>Matt Porter<email>mporter@kernel.crashing.org</email></para></listitem>
-		</orderedlist>
-	</para>
-  </chapter>
-</book>
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 8610aab8f342..1f8517db39c7 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -36,6 +36,7 @@ available subsections can be seen below.
    libata
    miscellaneous
    w1
+   rapidio
    s390-drivers
    vme
    80211/index
diff --git a/Documentation/driver-api/rapidio.rst b/Documentation/driver-api/rapidio.rst
new file mode 100644
index 000000000000..71ff658ab78e
--- /dev/null
+++ b/Documentation/driver-api/rapidio.rst
@@ -0,0 +1,107 @@
+=======================
+RapidIO Subsystem Guide
+=======================
+
+:Author: Matt Porter
+
+Introduction
+============
+
+RapidIO is a high speed switched fabric interconnect with features aimed
+at the embedded market. RapidIO provides support for memory-mapped I/O
+as well as message-based transactions over the switched fabric network.
+RapidIO has a standardized discovery mechanism not unlike the PCI bus
+standard that allows simple detection of devices in a network.
+
+This documentation is provided for developers intending to support
+RapidIO on new architectures, write new drivers, or to understand the
+subsystem internals.
+
+Known Bugs and Limitations
+==========================
+
+Bugs
+----
+
+None. ;)
+
+Limitations
+-----------
+
+1. Access/management of RapidIO memory regions is not supported
+
+2. Multiple host enumeration is not supported
+
+RapidIO driver interface
+========================
+
+Drivers are provided a set of calls in order to interface with the
+subsystem to gather info on devices, request/map memory region
+resources, and manage mailboxes/doorbells.
+
+Functions
+---------
+
+.. kernel-doc:: include/linux/rio_drv.h
+   :internal:
+
+.. kernel-doc:: drivers/rapidio/rio-driver.c
+   :export:
+
+.. kernel-doc:: drivers/rapidio/rio.c
+   :export:
+
+Internals
+=========
+
+This chapter contains the autogenerated documentation of the RapidIO
+subsystem.
+
+Structures
+----------
+
+.. kernel-doc:: include/linux/rio.h
+   :internal:
+
+Enumeration and Discovery
+-------------------------
+
+.. kernel-doc:: drivers/rapidio/rio-scan.c
+   :internal:
+
+Driver functionality
+--------------------
+
+.. kernel-doc:: drivers/rapidio/rio.c
+   :internal:
+
+.. kernel-doc:: drivers/rapidio/rio-access.c
+   :internal:
+
+Device model support
+--------------------
+
+.. kernel-doc:: drivers/rapidio/rio-driver.c
+   :internal:
+
+PPC32 support
+-------------
+
+.. kernel-doc:: arch/powerpc/sysdev/fsl_rio.c
+   :internal:
+
+Credits
+=======
+
+The following people have contributed to the RapidIO subsystem directly
+or indirectly:
+
+1. Matt Porter\ mporter@kernel.crashing.org
+
+2. Randy Vinson\ rvinson@mvista.com
+
+3. Dan Malek\ dan@embeddedalley.com
+
+The following people have contributed to this document:
+
+1. Matt Porter\ mporter@kernel.crashing.org
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642529 — [PATCH v2 27/53] docs-rst: convert s390-drivers DocBook to ReST

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:40 +0200
Subject	[PATCH v2 27/53] docs-rst: convert s390-drivers DocBook to ReST
Message-ID	<tHJVE-5BS-25@gated-at.bofh.it>
In reply to	#1642478

Use pandoc to convert documentation to ReST by calling
Documentation/sphinx/tmplcvt script.

Acked-by: Cornelia Huck <cornelia.huck@de.ibm.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/DocBook/Makefile            |   2 +-
 Documentation/DocBook/s390-drivers.tmpl   | 161 ------------------------------
 Documentation/driver-api/index.rst        |   1 +
 Documentation/driver-api/s390-drivers.rst | 111 ++++++++++++++++++++
 4 files changed, 113 insertions(+), 162 deletions(-)
 delete mode 100644 Documentation/DocBook/s390-drivers.tmpl
 create mode 100644 Documentation/driver-api/s390-drivers.rst

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index abe71345160b..a25bf10384e1 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -10,7 +10,7 @@ DOCBOOKS := z8530book.xml  \
 	    networking.xml \
 	    lsm.xml \
 	    mtdnand.xml librs.xml rapidio.xml \
-	    s390-drivers.xml scsi.xml \
+	    scsi.xml \
 	    sh.xml w1.xml
 
 ifeq ($(DOCBOOKS),)
diff --git a/Documentation/DocBook/s390-drivers.tmpl b/Documentation/DocBook/s390-drivers.tmpl
deleted file mode 100644
index 95bfc12e5439..000000000000
--- a/Documentation/DocBook/s390-drivers.tmpl
+++ /dev/null
@@ -1,161 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
-
-<book id="s390drivers">
- <bookinfo>
-  <title>Writing s390 channel device drivers</title>
-
-  <authorgroup>
-   <author>
-    <firstname>Cornelia</firstname>
-    <surname>Huck</surname>
-    <affiliation>
-     <address>
-       <email>cornelia.huck@de.ibm.com</email>
-     </address>
-    </affiliation>
-   </author>
-  </authorgroup>
-
-  <copyright>
-   <year>2007</year>
-   <holder>IBM Corp.</holder>
-  </copyright>
-
-  <legalnotice>
-   <para>
-     This documentation is free software; you can redistribute
-     it and/or modify it under the terms of the GNU General Public
-     License as published by the Free Software Foundation; either
-     version 2 of the License, or (at your option) any later
-     version.
-   </para>
-
-   <para>
-     This program is distributed in the hope that it will be
-     useful, but WITHOUT ANY WARRANTY; without even the implied
-     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-     See the GNU General Public License for more details.
-   </para>
-
-   <para>
-     You should have received a copy of the GNU General Public
-     License along with this program; if not, write to the Free
-     Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
-     MA 02111-1307 USA
-   </para>
-
-   <para>
-     For more details see the file COPYING in the source
-     distribution of Linux.
-   </para>
-  </legalnotice>
- </bookinfo>
-
-<toc></toc>
-
-  <chapter id="intro">
-   <title>Introduction</title>
-  <para>
-    This document describes the interfaces available for device drivers that
-    drive s390 based channel attached I/O devices. This includes interfaces for
-    interaction with the hardware and interfaces for interacting with the
-    common driver core. Those interfaces are provided by the s390 common I/O
-    layer.
-  </para>
-  <para>
-    The document assumes a familarity with the technical terms associated
-    with the s390 channel I/O architecture. For a description of this
-    architecture, please refer to the "z/Architecture: Principles of
-    Operation", IBM publication no. SA22-7832.
-  </para>
-  <para>
-    While most I/O devices on a s390 system are typically driven through the
-    channel I/O mechanism described here, there are various other methods
-    (like the diag interface). These are out of the scope of this document.
-  </para>
-  <para>
-    Some additional information can also be found in the kernel source
-    under Documentation/s390/driver-model.txt.
-  </para>
-  </chapter>
-  <chapter id="ccw">
-   <title>The ccw bus</title>
-  <para>
-	The ccw bus typically contains the majority of devices available to
-	a s390 system. Named after the channel command word (ccw), the basic
-	command structure used to address its devices, the ccw bus contains
-	so-called channel attached devices. They are addressed via I/O
-	subchannels, visible on the css bus. A device driver for
-	channel-attached devices, however, will never interact	with the
-	subchannel directly, but only via the I/O device on the ccw bus,
-	the ccw device.
-  </para>
-    <sect1 id="channelIO">
-     <title>I/O functions for channel-attached devices</title>
-    <para>
-      Some hardware structures have been translated into C structures for use
-      by the common I/O layer and device drivers. For more information on
-      the hardware structures represented here, please consult the Principles
-      of Operation.
-    </para>
-!Iarch/s390/include/asm/cio.h
-    </sect1>
-    <sect1 id="ccwdev">
-     <title>ccw devices</title>
-    <para>
-      Devices that want to initiate channel I/O need to attach to the ccw bus.
-      Interaction with the driver core is done via the common I/O layer, which
-      provides the abstractions of ccw devices and ccw device drivers.
-    </para>
-    <para>
-      The functions that initiate or terminate channel I/O all act upon a
-      ccw device structure. Device drivers must not bypass those functions
-      or strange side effects may happen.
-    </para>
-!Iarch/s390/include/asm/ccwdev.h
-!Edrivers/s390/cio/device.c
-!Edrivers/s390/cio/device_ops.c
-    </sect1>
-    <sect1 id="cmf">
-     <title>The channel-measurement facility</title>
-  <para>
-	The channel-measurement facility provides a means to collect
-	measurement data which is made available by the channel subsystem
-	for each channel attached device.
-  </para>
-!Iarch/s390/include/asm/cmb.h
-!Edrivers/s390/cio/cmf.c
-    </sect1>
-  </chapter>
-
-  <chapter id="ccwgroup">
-   <title>The ccwgroup bus</title>
-  <para>
-	The ccwgroup bus only contains artificial devices, created by the user.
-	Many networking devices (e.g. qeth) are in fact composed of several
-	ccw devices (like read, write and data channel for qeth). The
-	ccwgroup bus provides a mechanism to create a meta-device which
-	contains those ccw devices as slave devices and can be associated
-	with the netdevice.
-  </para>
-   <sect1 id="ccwgroupdevices">
-    <title>ccw group devices</title>
-!Iarch/s390/include/asm/ccwgroup.h
-!Edrivers/s390/cio/ccwgroup.c
-   </sect1>
-  </chapter>
-
-  <chapter id="genericinterfaces">
-   <title>Generic interfaces</title>
-  <para>
-	Some interfaces are available to other drivers that do not necessarily
-	have anything to do with the busses described above, but still are
-	indirectly using basic infrastructure in the common I/O layer.
-	One example is the support for adapter interrupts.
-  </para>
-!Edrivers/s390/cio/airq.c
-  </chapter>
-
-</book>
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index c3c50b1bb96c..a9687731810e 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -34,6 +34,7 @@ available subsections can be seen below.
    edac
    libata
    miscellaneous
+   s390-drivers
    vme
    80211/index
    uio-howto
diff --git a/Documentation/driver-api/s390-drivers.rst b/Documentation/driver-api/s390-drivers.rst
new file mode 100644
index 000000000000..7060da136095
--- /dev/null
+++ b/Documentation/driver-api/s390-drivers.rst
@@ -0,0 +1,111 @@
+===================================
+Writing s390 channel device drivers
+===================================
+
+:Author: Cornelia Huck
+
+Introduction
+============
+
+This document describes the interfaces available for device drivers that
+drive s390 based channel attached I/O devices. This includes interfaces
+for interaction with the hardware and interfaces for interacting with
+the common driver core. Those interfaces are provided by the s390 common
+I/O layer.
+
+The document assumes a familarity with the technical terms associated
+with the s390 channel I/O architecture. For a description of this
+architecture, please refer to the "z/Architecture: Principles of
+Operation", IBM publication no. SA22-7832.
+
+While most I/O devices on a s390 system are typically driven through the
+channel I/O mechanism described here, there are various other methods
+(like the diag interface). These are out of the scope of this document.
+
+Some additional information can also be found in the kernel source under
+Documentation/s390/driver-model.txt.
+
+The ccw bus
+===========
+
+The ccw bus typically contains the majority of devices available to a
+s390 system. Named after the channel command word (ccw), the basic
+command structure used to address its devices, the ccw bus contains
+so-called channel attached devices. They are addressed via I/O
+subchannels, visible on the css bus. A device driver for
+channel-attached devices, however, will never interact with the
+subchannel directly, but only via the I/O device on the ccw bus, the ccw
+device.
+
+I/O functions for channel-attached devices
+------------------------------------------
+
+Some hardware structures have been translated into C structures for use
+by the common I/O layer and device drivers. For more information on the
+hardware structures represented here, please consult the Principles of
+Operation.
+
+.. kernel-doc:: arch/s390/include/asm/cio.h
+   :internal:
+
+ccw devices
+-----------
+
+Devices that want to initiate channel I/O need to attach to the ccw bus.
+Interaction with the driver core is done via the common I/O layer, which
+provides the abstractions of ccw devices and ccw device drivers.
+
+The functions that initiate or terminate channel I/O all act upon a ccw
+device structure. Device drivers must not bypass those functions or
+strange side effects may happen.
+
+.. kernel-doc:: arch/s390/include/asm/ccwdev.h
+   :internal:
+
+.. kernel-doc:: drivers/s390/cio/device.c
+   :export:
+
+.. kernel-doc:: drivers/s390/cio/device_ops.c
+   :export:
+
+The channel-measurement facility
+--------------------------------
+
+The channel-measurement facility provides a means to collect measurement
+data which is made available by the channel subsystem for each channel
+attached device.
+
+.. kernel-doc:: arch/s390/include/asm/cmb.h
+   :internal:
+
+.. kernel-doc:: drivers/s390/cio/cmf.c
+   :export:
+
+The ccwgroup bus
+================
+
+The ccwgroup bus only contains artificial devices, created by the user.
+Many networking devices (e.g. qeth) are in fact composed of several ccw
+devices (like read, write and data channel for qeth). The ccwgroup bus
+provides a mechanism to create a meta-device which contains those ccw
+devices as slave devices and can be associated with the netdevice.
+
+ccw group devices
+-----------------
+
+.. kernel-doc:: arch/s390/include/asm/ccwgroup.h
+   :internal:
+
+.. kernel-doc:: drivers/s390/cio/ccwgroup.c
+   :export:
+
+Generic interfaces
+==================
+
+Some interfaces are available to other drivers that do not necessarily
+have anything to do with the busses described above, but still are
+indirectly using basic infrastructure in the common I/O layer. One
+example is the support for adapter interrupts.
+
+.. kernel-doc:: drivers/s390/cio/airq.c
+   :export:
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642530 — [PATCH v2 26/53] libata: fix identation on a kernel-doc markup

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:40 +0200
Subject	[PATCH v2 26/53] libata: fix identation on a kernel-doc markup
Message-ID	<tHJVE-5BS-27@gated-at.bofh.it>
In reply to	#1642478

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 <mchehab@s-opensource.com>
---
 drivers/ata/libata-scsi.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/drivers/ata/libata-scsi.c b/drivers/ata/libata-scsi.c
index 49ba9834c715..dcd38d9e9804 100644
--- a/drivers/ata/libata-scsi.c
+++ b/drivers/ata/libata-scsi.c
@@ -3398,9 +3398,10 @@ static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
  *
  * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
  * an SCT Write Same command.
- * Based on WRITE SAME has the UNMAP flag
- *   When set translate to DSM TRIM
- *   When clear translate to SCT Write Same
+ * Based on WRITE SAME has the UNMAP flag:
+ *
+ *   - When set translate to DSM TRIM
+ *   - When clear translate to SCT Write Same
  */
 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
 {
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642531 — [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:40 +0200
Subject	[PATCH v2 38/53] mtdnand.rst: group the "::" with previous line
Message-ID	<tHJVE-5BS-29@gated-at.bofh.it>
In reply to	#1642478

Group the :: with the previous paragraph, in order to make it
visually better when reading as a text file.

While here, replace:
	ored (with means "Covered or adorned with ore or metal")
by:
	OR-ed

To reflect its true meaning.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/driver-api/mtdnand.rst | 24 +++++++-----------------
 1 file changed, 7 insertions(+), 17 deletions(-)

diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
index 8723175f955e..7c19795ebb4a 100644
--- a/Documentation/driver-api/mtdnand.rst
+++ b/Documentation/driver-api/mtdnand.rst
@@ -843,10 +843,8 @@ Chip option constants
 Constants for chip id table
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-These constants are defined in nand.h. They are ored together to
-describe the chip functionality.
-
-::
+These constants are defined in nand.h. They are OR-ed together to
+describe the chip functionality::
 
     /* Buswitdh is 16 bit */
     #define NAND_BUSWIDTH_16    0x00000002
@@ -867,10 +865,8 @@ describe the chip functionality.
 Constants for runtime options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-These constants are defined in nand.h. They are ored together to
-describe the functionality.
-
-::
+These constants are defined in nand.h. They are OR-ed together to
+describe the functionality::
 
     /* The hw ecc generator provides a syndrome instead a ecc value on read
      * This can only work if we have the ecc bytes directly behind the
@@ -881,9 +877,7 @@ describe the functionality.
 ECC selection constants
 -----------------------
 
-Use these constants to select the ECC algorithm.
-
-::
+Use these constants to select the ECC algorithm::
 
     /* No ECC. Usage is not recommended ! */
     #define NAND_ECC_NONE       0
@@ -903,9 +897,7 @@ Hardware control related constants
 ----------------------------------
 
 These constants describe the requested hardware access function when the
-boardspecific hardware control function is called
-
-::
+boardspecific hardware control function is called::
 
     /* Select the chip by setting nCE to low */
     #define NAND_CTL_SETNCE     1
@@ -929,9 +921,7 @@ Bad block table related constants
 ---------------------------------
 
 These constants describe the options used for bad block table
-descriptors.
-
-::
+descriptors::
 
     /* Options for the bad block table descriptors */
 
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1642556 — Re: [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line

From	Boris Brezillon <boris.brezillon@free-electrons.com>
Date	2017-05-16 15:20 +0200
Subject	Re: [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line
Message-ID	<tHKym-65Z-11@gated-at.bofh.it>
In reply to	#1642531

On Tue, 16 May 2017 09:16:30 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:

> Group the :: with the previous paragraph, in order to make it
> visually better when reading as a text file.
> 
> While here, replace:
> 	ored (with means "Covered or adorned with ore or metal")
> by:
> 	OR-ed
> 
> To reflect its true meaning.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Acked-by: Boris Brezillon <boris.brezillon@free-electrons.com>

> ---
>  Documentation/driver-api/mtdnand.rst | 24 +++++++-----------------
>  1 file changed, 7 insertions(+), 17 deletions(-)
> 
> diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
> index 8723175f955e..7c19795ebb4a 100644
> --- a/Documentation/driver-api/mtdnand.rst
> +++ b/Documentation/driver-api/mtdnand.rst
> @@ -843,10 +843,8 @@ Chip option constants
>  Constants for chip id table
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -These constants are defined in nand.h. They are ored together to
> -describe the chip functionality.
> -
> -::
> +These constants are defined in nand.h. They are OR-ed together to
> +describe the chip functionality::
>  
>      /* Buswitdh is 16 bit */
>      #define NAND_BUSWIDTH_16    0x00000002
> @@ -867,10 +865,8 @@ describe the chip functionality.
>  Constants for runtime options
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -These constants are defined in nand.h. They are ored together to
> -describe the functionality.
> -
> -::
> +These constants are defined in nand.h. They are OR-ed together to
> +describe the functionality::
>  
>      /* The hw ecc generator provides a syndrome instead a ecc value on read
>       * This can only work if we have the ecc bytes directly behind the
> @@ -881,9 +877,7 @@ describe the functionality.
>  ECC selection constants
>  -----------------------
>  
> -Use these constants to select the ECC algorithm.
> -
> -::
> +Use these constants to select the ECC algorithm::
>  
>      /* No ECC. Usage is not recommended ! */
>      #define NAND_ECC_NONE       0
> @@ -903,9 +897,7 @@ Hardware control related constants
>  ----------------------------------
>  
>  These constants describe the requested hardware access function when the
> -boardspecific hardware control function is called
> -
> -::
> +boardspecific hardware control function is called::
>  
>      /* Select the chip by setting nCE to low */
>      #define NAND_CTL_SETNCE     1
> @@ -929,9 +921,7 @@ Bad block table related constants
>  ---------------------------------
>  
>  These constants describe the options used for bad block table
> -descriptors.
> -
> -::
> +descriptors::
>  
>      /* Options for the bad block table descriptors */
>

[toc] | [prev] | [next] | [standalone]

#1642532 — [PATCH v2 40/53] docs-rst: convert sh book to ReST

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-16 14:40 +0200
Subject	[PATCH v2 40/53] docs-rst: convert sh book to ReST
Message-ID	<tHJVE-5BS-31@gated-at.bofh.it>
In reply to	#1642478

Use pandoc to convert documentation to ReST by calling
Documentation/sphinx/tmplcvt script.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/DocBook/Makefile |   4 +-
 Documentation/DocBook/sh.tmpl  | 105 -----------------------------------------
 Documentation/conf.py          |   2 +
 Documentation/index.rst        |  11 +++++
 Documentation/sh/conf.py       |  10 ++++
 Documentation/sh/index.rst     |  59 +++++++++++++++++++++++
 6 files changed, 83 insertions(+), 108 deletions(-)
 delete mode 100644 Documentation/DocBook/sh.tmpl
 create mode 100644 Documentation/sh/conf.py
 create mode 100644 Documentation/sh/index.rst

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index 226e5e9fc801..efba7f980895 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -6,9 +6,7 @@
 # To add a new book the only step required is to add the book to the
 # list of DOCBOOKS.
 
-DOCBOOKS := \
-	    lsm.xml \
-	    sh.xml
+DOCBOOKS := lsm.xml
 
 ifeq ($(DOCBOOKS),)
 
diff --git a/Documentation/DocBook/sh.tmpl b/Documentation/DocBook/sh.tmpl
deleted file mode 100644
index 4a38f604fa66..000000000000
--- a/Documentation/DocBook/sh.tmpl
+++ /dev/null
@@ -1,105 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
-
-<book id="sh-drivers">
- <bookinfo>
-  <title>SuperH Interfaces Guide</title>
-  
-  <authorgroup>
-   <author>
-    <firstname>Paul</firstname>
-    <surname>Mundt</surname>
-    <affiliation>
-     <address>
-      <email>lethal@linux-sh.org</email>
-     </address>
-    </affiliation>
-   </author>
-  </authorgroup>
-
-  <copyright>
-   <year>2008-2010</year>
-   <holder>Paul Mundt</holder>
-  </copyright>
-  <copyright>
-   <year>2008-2010</year>
-   <holder>Renesas Technology Corp.</holder>
-  </copyright>
-  <copyright>
-   <year>2010</year>
-   <holder>Renesas Electronics Corp.</holder>
-  </copyright>
-
-  <legalnotice>
-   <para>
-     This documentation is free software; you can redistribute
-     it and/or modify it under the terms of the GNU General Public
-     License version 2 as published by the Free Software Foundation.
-   </para>
-      
-   <para>
-     This program is distributed in the hope that it will be
-     useful, but WITHOUT ANY WARRANTY; without even the implied
-     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-     See the GNU General Public License for more details.
-   </para>
-      
-   <para>
-     You should have received a copy of the GNU General Public
-     License along with this program; if not, write to the Free
-     Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
-     MA 02111-1307 USA
-   </para>
-      
-   <para>
-     For more details see the file COPYING in the source
-     distribution of Linux.
-   </para>
-  </legalnotice>
- </bookinfo>
-
-<toc></toc>
-
-  <chapter id="mm">
-    <title>Memory Management</title>
-    <sect1 id="sh4">
-    <title>SH-4</title>
-      <sect2 id="sq">
-        <title>Store Queue API</title>
-!Earch/sh/kernel/cpu/sh4/sq.c
-      </sect2>
-    </sect1>
-    <sect1 id="sh5">
-      <title>SH-5</title>
-      <sect2 id="tlb">
-	<title>TLB Interfaces</title>
-!Iarch/sh/mm/tlb-sh5.c
-!Iarch/sh/include/asm/tlb_64.h
-      </sect2>
-    </sect1>
-  </chapter>
-  <chapter id="mach">
-    <title>Machine Specific Interfaces</title>
-    <sect1 id="dreamcast">
-      <title>mach-dreamcast</title>
-!Iarch/sh/boards/mach-dreamcast/rtc.c
-    </sect1>
-    <sect1 id="x3proto">
-      <title>mach-x3proto</title>
-!Earch/sh/boards/mach-x3proto/ilsel.c
-    </sect1>
-  </chapter>
-  <chapter id="busses">
-    <title>Busses</title>
-    <sect1 id="superhyway">
-      <title>SuperHyway</title>
-!Edrivers/sh/superhyway/superhyway.c
-    </sect1>
-
-    <sect1 id="maple">
-      <title>Maple</title>
-!Edrivers/sh/maple/maple.c
-    </sect1>
-  </chapter>
-</book>
diff --git a/Documentation/conf.py b/Documentation/conf.py
index dfe14f7525d0..77d47bb1df1d 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -375,6 +375,8 @@ latex_documents = [
      'The kernel development community', 'manual'),
     ('security/index', 'security.tex', 'The kernel security subsystem manual',
      'The kernel development community', 'manual'),
+    ('sh/index', 'sh.tex', 'SuperH architecture implementation manual',
+     'The kernel development community', 'manual'),
     ('sound/index', 'sound.tex', 'Linux Sound Subsystem Documentation',
      'The kernel development community', 'manual'),
     ('userspace-api/index', 'userspace-api.tex', 'The Linux kernel user-space API guide',
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 25c4da41da6b..e9017bb3a6ce 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -76,6 +76,17 @@ needed).
    crypto/index
    filesystems/index
 
+Architecture-specific documentation
+-----------------------------------
+
+These books provide programming details about architecture-specific
+implementation.
+
+.. toctree::
+   :maxdepth: 2
+
+   sh/index
+
 Korean translations
 -------------------
 
diff --git a/Documentation/sh/conf.py b/Documentation/sh/conf.py
new file mode 100644
index 000000000000..1eb684a13ac8
--- /dev/null
+++ b/Documentation/sh/conf.py
@@ -0,0 +1,10 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = "SuperH architecture implementation manual"
+
+tags.add("subproject")
+
+latex_documents = [
+    ('index', 'sh.tex', project,
+     'The kernel development community', 'manual'),
+]
diff --git a/Documentation/sh/index.rst b/Documentation/sh/index.rst
new file mode 100644
index 000000000000..bc8db7ba894a
--- /dev/null
+++ b/Documentation/sh/index.rst
@@ -0,0 +1,59 @@
+=======================
+SuperH Interfaces Guide
+=======================
+
+:Author: Paul Mundt
+
+Memory Management
+=================
+
+SH-4
+----
+
+Store Queue API
+~~~~~~~~~~~~~~~
+
+.. kernel-doc:: arch/sh/kernel/cpu/sh4/sq.c
+   :export:
+
+SH-5
+----
+
+TLB Interfaces
+~~~~~~~~~~~~~~
+
+.. kernel-doc:: arch/sh/mm/tlb-sh5.c
+   :internal:
+
+.. kernel-doc:: arch/sh/include/asm/tlb_64.h
+   :internal:
+
+Machine Specific Interfaces
+===========================
+
+mach-dreamcast
+--------------
+
+.. kernel-doc:: arch/sh/boards/mach-dreamcast/rtc.c
+   :internal:
+
+mach-x3proto
+------------
+
+.. kernel-doc:: arch/sh/boards/mach-x3proto/ilsel.c
+   :export:
+
+Busses
+======
+
+SuperHyway
+----------
+
+.. kernel-doc:: drivers/sh/superhyway/superhyway.c
+   :export:
+
+Maple
+-----
+
+.. kernel-doc:: drivers/sh/maple/maple.c
+   :export:
-- 
2.9.3

[toc] | [prev] | [next] | [standalone]

#1644773

From	Jonathan Corbet <corbet@lwn.net>
Date	2017-05-18 19:30 +0200
Message-ID	<tIxpo-5Nu-29@gated-at.bofh.it>
In reply to	#1642478

On Tue, 16 May 2017 09:15:52 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:

> This patch series convert the remaining DocBooks to ReST.

Gotta love this:

>  124 files changed, 7469 insertions(+), 10511 deletions(-)

I've just pulled the whole set from your experimental.git repo.  There are
certainly a few rough edges, but that means it will fit into the rest of
the docs just fine :)

There are a few loose ends, but, rather than complaining about them, I'll
just see what's to be done about them.

Thanks for pushing this through, this is a nice milestone.

jon

[toc] | [prev] | [next] | [standalone]

#1644946

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Date	2017-05-19 01:10 +0200
Message-ID	<tICIp-1Ed-5@gated-at.bofh.it>
In reply to	#1644773

Em Thu, 18 May 2017 11:26:08 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Tue, 16 May 2017 09:15:52 -0300
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> 
> > This patch series convert the remaining DocBooks to ReST.
> 
> Gotta love this:
> 
> >  124 files changed, 7469 insertions(+), 10511 deletions(-)

Heh, yeah, lots of stuff changed :-)

> I've just pulled the whole set from your experimental.git repo.  There are
> certainly a few rough edges, but that means it will fit into the rest of
> the docs just fine :)

:-)

> There are a few loose ends, but, rather than complaining about them, I'll
> just see what's to be done about them.

Yeah, a change like that will likely have a few loose ends. One of them
is with regards to Documentation/kernel-doc-nano-HOWTO.txt: we may
think on removing it soon, as I guess the important stuff there is
already under Documentation/doc-guide.

> Thanks for pushing this through, this is a nice milestone.

Anytime!

Btw, it seems I didn't have much to do this week[1]... I produced a 
changeset series with 90+ patches that standardize the 
Documentation/*.txt files, making them parseable by Sphinx. I
opted to keep the files where they are, and don't update
anything else but the text format, as I'm pretty sure that
some of the files there are really outdated.

The rationale for doing that is that it would minimize the
risk of someone add a new text document under Documentation
using some other random format, as at least the documents
on the main documentation dir will all have the same format.

I'll be mailbombing them soon (perhaps splitting into 3
series with ~30 patches each).

[1] The reality is that I moved to another place, and didn't
have time yet to unpack the machines and media test boards yet...
So, I decided to have some fun with docs ;)

Thanks,
Mauro

[toc] | [prev] | [standalone]

Page 3 of 3 — ← Prev page 1 2 [3]

csiph-web

[PATCH v2 00/53] Get rid of Docbook

Contents

#1642730 — Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST

#1642769 — Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST

#1642518 — [PATCH v2 21/53] fs: add a blank lines on some kernel-doc comments

#1642519 — [PATCH v2 11/53] docs-rst: conf.py: sort LaTeX documents in alphabetical order

#1642521 — [PATCH v2 12/53] docs-rst: conf.py: remove kernel-documentation from LaTeX

#1642522 — [PATCH v2 43/53] docs: update old references for DocBook from the documentation

#1643517 — Re: [PATCH v2 43/53] docs: update old references for DocBook from the documentation

#1642524 — [PATCH v2 13/53] docs-rst: add crypto API book to pdf output

#1642526 — [PATCH v2 22/53] fs: eventfd: fix identation on kernel-doc

#1642528 — [PATCH v2 35/53] docs-rst: convert rapidio book to ReST

#1642529 — [PATCH v2 27/53] docs-rst: convert s390-drivers DocBook to ReST

#1642530 — [PATCH v2 26/53] libata: fix identation on a kernel-doc markup

#1642531 — [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line

#1642556 — Re: [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line

#1642532 — [PATCH v2 40/53] docs-rst: convert sh book to ReST

#1644773

#1644946