Re: [PATCH v2 3/3] Documentation/workqueue.txt: convert to ReST markup

[Tejun Heo]

Hello,

On Sun, Oct 23, 2016 at 10:27:34AM -0600, Jonathan Corbet wrote:
> That done, if it's OK with you, Tejun, I'd prefer to take it through the
> docs tree with your ack so I don't have to write yet another note to Linus
> explaining the index.rst conflicts...

Please feel free to add my ack and route it through the docs tree.

Thanks.

-- 
tejun
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 3/3] Documentation/workqueue.txt: convert to ReST markup

[S. Fricke]

Hi Jon,

> On Wed, 19 Oct 2016 20:38:39 +0200
> Silvio Fricke  wrote:
> 
> > This patch add a "misc" documentation section and add the workqueue
> 
> Thanks for doing this; can I add a few comments?
> 
> - Ccing the docs maintainer is considered good form with documentation
>   patches :)  That's especially true of anything touching index.rst, which
>   has become a bit of a conflict point.
> 
> - On a quick read, the conversion of workqueue.txt seems good.
> 
> - I don't like the "misc" thing, though.
> 
> As we convert the documentation over, we want to impose a bit more
> organization on it, both in the documentation structure and in the
> filesystem structure.  That means moving a lot of the stuff out of the
> top-level Documentation/ directory, which is an unmanageable mess at the
> moment.  So one thing I would really rather not see is people creating
> index.rst files with "../" in them.  The file hierarchy should match the
> document hierarchy.
> 
> For 4.9 we created the driver-api manual for stuff that's clearly
> driver-specific.  My thinking had been to make a core-api equivalent for
> stuff that's relevant outside of the driver code; workqueue.txt clearly
> qualifies there.
> 
> So I guess what I'd like to see is something very similar to what you've
> done, but can we start the core-api manual, and put the RST file as
> core-api/workqueue.rst?  The core-api manual itself doesn't really need to
> be any more than what you did for misc/ at this point.

Thanks for your hints, I will update my patchset.  


Best regards,
Silvio

> That done, if it's OK with you, Tejun, I'd prefer to take it through the
> docs tree with your ack so I don't have to write yet another note to Linus
> explaining the index.rst conflicts...
> 
> Sound OK?
> 
> Thanks,
> 
> jon

-- 
-- S. Fricke  sil...@port1024.net --
   Diplom-Informatiker (FH)
   Linux-Entwicklung JABBER: sil...@conversation.port1024.net   

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 3/3] Documentation/workqueue.txt: convert to ReST markup

[Jonathan Corbet]

On Wed, 19 Oct 2016 20:38:39 +0200
Silvio Fricke  wrote:

> This patch add a "misc" documentation section and add the workqueue

Thanks for doing this; can I add a few comments?

- Ccing the docs maintainer is considered good form with documentation
  patches :)  That's especially true of anything touching index.rst, which
  has become a bit of a conflict point.

- On a quick read, the conversion of workqueue.txt seems good.

- I don't like the "misc" thing, though.

As we convert the documentation over, we want to impose a bit more
organization on it, both in the documentation structure and in the
filesystem structure.  That means moving a lot of the stuff out of the
top-level Documentation/ directory, which is an unmanageable mess at the
moment.  So one thing I would really rather not see is people creating
index.rst files with "../" in them.  The file hierarchy should match the
document hierarchy.

For 4.9 we created the driver-api manual for stuff that's clearly
driver-specific.  My thinking had been to make a core-api equivalent for
stuff that's relevant outside of the driver code; workqueue.txt clearly
qualifies there.

So I guess what I'd like to see is something very similar to what you've
done, but can we start the core-api manual, and put the RST file as
core-api/workqueue.rst?  The core-api manual itself doesn't really need to
be any more than what you did for misc/ at this point.

That done, if it's OK with you, Tejun, I'd prefer to take it through the
docs tree with your ack so I don't have to write yet another note to Linus
explaining the index.rst conflicts...

Sound OK?

Thanks,

jon
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2 3/3] Documentation/workqueue.txt: convert to ReST markup

[Tejun Heo]

On Wed, Oct 19, 2016 at 08:38:39PM +0200, Silvio Fricke wrote:
> This patch add a "misc" documentation section and add the workqueue
> documentation to this section.
> 
> Signed-off-by: Silvio Fricke 

Looks good to me.  How should these patches be routed?  Should I take
2 and 3 through wq/for-4.10?

Thanks.

-- 
tejun
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html