On Sun, 2016-10-23 at 12:58 +0200, Markus Heiser wrote:
> If you don't want to see a warning log, we have to consider
> a solution like Johannes Berg posted here:
>
> https://www.mail-archive.com/linux-doc@vger.kernel.org/msg07071.html
>
> @johannes: since this thread and our "sequence
On Mon, 24 Oct 2016, Markus Heiser wrote:
> The conf.py becomes more and more unclear, mainly caused by all those
> out-commented settings. As a result, we have out-dated (rst2pdf) and
> useless (man/texinfo) settings and others (sphinx version) are missed.
> Its time
On Mon, 24 Oct 2016, Johannes Berg wrote:
> But yes, I also agree that we shouldn't add any dependencies where the
> input isn't suitable as a fallback, since that also means that the
> input is going to be difficult to read and write in the source, which
> should
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
On Mon, 24 Oct 2016, Johannes Berg wrote:
> On Sun, 2016-10-23 at 12:58 +0200, Markus Heiser wrote:
>> Further I think we should not generate more (and more) external
>> requirements like e.g. plantuml, Java or reportlab discussed here:
>
> I still disagree, I think we
> I'd like to refine: Do not add non-trivial hard dependencies. Do not
> add dependencies the lack of which make large parts of generated
> documentation useless.
>
> Graceful degradation on unmet dependencies is the key here.
Agree.
> Give a build
> warn about missing dependencies. Try to do
I think I saw some of this in the past [1], but then couldn't reproduce
it after all. Now I'm seeing it again. Sporadically
Documentation/media/uapi/cec/ gets rebuilt on successive runs of make
htmldocs, even when nothing has changed.
Output of 'make SPHINXOPTS="-v -v" htmldocs' attached for
On 10/21/2016 4:33 PM, Yury Norov wrote:
Based on Andrew Pinski's patch-series.
Signed-off-by: Yury Norov
---
Documentation/arm64/ilp32.txt | 46 +++
1 file changed, 46 insertions(+)
create mode 100644
On Monday, October 24, 2016 12:30:47 PM CEST Chris Metcalf wrote:
> On 10/21/2016 4:33 PM, Yury Norov wrote:
> > All new 32-bit architectures should have 64-bit off_t type, but existing
> > architectures has 32-bit ones.
> >
> > [...]
> > For syscalls sys_openat() and sys_open_by_handle_at()
On Sun, Oct 23, 2016 at 06:46:12PM +0200, Stephan Mueller wrote:
> Am Sonntag, 23. Oktober 2016, 10:32:38 CEST schrieb Jonathan Corbet:
>
> Hi Jonathan,
>
> > On Fri, 21 Oct 2016 04:53:45 +0200
> >
> > Stephan Mueller wrote:
> > > the attached patch set converts the
Jonathan Corbet writes:
> On Mon, 17 Oct 2016 16:26:23 +0100
> Punit Agrawal wrote:
>
>> The dma mapping api howto gives the impression that using the
>> dma_set_mask_and_coherent (and related DMA APIs) will cause the kernel
>> to check all the components
On Fri, Oct 21, 2016 at 03:09:16PM -0600, Jonathan Corbet wrote:
> On Mon, 17 Oct 2016 16:26:23 +0100
> Punit Agrawal wrote:
>
> > The dma mapping api howto gives the impression that using the
> > dma_set_mask_and_coherent (and related DMA APIs) will cause the kernel
> >
Am 24.10.2016 um 09:56 schrieb Jani Nikula :
>> * set minimal Sphinx version (needs_sphinx=1.2)
>
> This change is not cleanup. Cleanups and functional changes must be
> separate patches.
Ah, thanks for the hint .. I will separate the following 4 changes
* drop no
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab :
> We can't use :ref: for external links.
>
> Signed-off-by: Mauro Carvalho Chehab
> ---
> Documentation/applying-patches.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
>
Add minimal conf.py and moved dev-tools/tools.rst to dev-tools/index.rst
makes the dev-tools folder buildable stand-alone. To build only this
folder run::
make SPHINXDIRS=dev-tools htmldocs
Signed-off-by: Markus Heiser
---
Documentation/dev-tools/conf.py
On Fri, Oct 21, 2016 at 03:17:14PM -0600, Jonathan Corbet wrote:
> On Thu, 20 Oct 2016 15:15:00 +0200
> Oliver Neukum wrote:
>
> > It does no good to mention The 2.4 kernel series and neglect
> > USB 3.x and XHCI. Also with type C and micro/mini USB we better
> > not talk about
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab :
> Fix ReST notation for a bullet item
>
> Signed-off-by: Mauro Carvalho Chehab
> ---
> Documentation/CodeOfConflict | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff
- Fix document title;
- use quote blocks where needed;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sysfs-rules.txt | 218
- Fix document title;
- use quote blocks where needed;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/VGA-softcursor.txt | 73
The dvb/ and video4linux/ dirs were removed, as now, all media
documentation is under media/.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/00-INDEX | 4
1 file changed, 4 deletions(-)
diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index
Convert it to ReST markup and add it to the user book:
- Add a title to the document;
- touch spaces/new lines to fix Sphinx format;
- use ``foo`` for commands;
- use quote blocks where needed;
- add it to the user book;
Signed-off-by: Mauro Carvalho Chehab
---
Convert adding-syscalls.txt to ReST markup and add it to the
development-process book:
- add extra lines to make Sphinx to correctly parse paragraphs;
- use quote blocks for examples;
- use monotonic font for dirs, function calls, etc;
- mark manpage pages using the right markup;
- add
Probably, unicode is something that we might remove from the
docs, as all modern systems support it. Yet, this chapter
is fun, as it mentions support for the Klington fictional
charset ;)
On the other hand, I bet all other OS user manuals
explicit mention unicode support.
So, convert it to ReST
This patch series continues the efforts of converting the Linux Kernel
documentation to Sphinx.
It contains text to ReST conversion of several files under Documentation,
and a few ones under the main dir (README, REPORTING-BUGS).
All patches on this series can be found on my development tree:
Add several documents to the development-process ReST book.
As we don't want renames, use symlinks instead, keeping those
documents on their original place.
Acked-by: Greg Kroah-Hartman
Signed-off-by: Mauro Carvalho Chehab
---
- add a title to the document;
- use :: before verbatim blocks;
- add blank lines where required;
- use protocol for URL references;
- use a verbatim block for the bugs template;
- add cross references to SecurityBugs.
Signed-off-by: Mauro Carvalho Chehab
---
Those files got moved to Documentation/process, but as they're very
well known files, add pointers to their new locations.
PS.: I opted to not merge this patch with the previous one
in order to make the diff of the previous one more consistent,
as it will show only renames.
Signed-off-by: Mauro
As we moved the real README file to Documentation/admin-guide/README.rst,
let's add a replacement, pointing to it, and giving the main directions
about documentation.
In the future, perhaps it would be worth to move the contents
of Documentation/00-Index into this README.
Signed-off-by: Mauro
Sphinx doesn't like nested tables on the LaTex output.
So, change the table there to be displayed properly at
the PDF output.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/parport.txt | 33 ++---
1 file changed, 22 insertions(+),
We can't use :ref: for external links.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/applying-patches.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/applying-patches.txt
b/Documentation/applying-patches.txt
index
- Fix document title;
- use a table for the valid commands;
- use quote blocks where needed;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
- Fix document section markups;
- use quote blocks where needed;
- adjust spaces and blank lines;
- add it to the development-processs book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/volatile-considered-harmful.txt | 19 +++
1 file changed,
Adjust the file for it to be parsed by Sphinx:
- adjust the document title to be parsed;
- use :: for quote blocks;
- fix the horizontal bar markup;
- lower case the TODO title.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/kernel-parameters.txt | 33
- Fix identation for the document title;
- use monotonic fonts for paths;
- use quote blocks where needed;
- adjust spaces to properly format paragraphs;
- use :menuselection: for the menu item;
- add it to the user book.
Signed-off-by: Mauro Carvalho Chehab
---
- use a quote blocks where needed;
- use ``foo`` for monotonic;
- adjust whitespaces and blank lines;
- fix the second list (that starts with 0, instead of A)
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/init.txt | 29
Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters
on an user's manual book.
As we'll be numbering the user's manual, remove the manual
numbering from SecurityBugs.
Signed-off-by: Mauro Carvalho Chehab
---
README => Documentation/admin-guide/README.rst
Fix ReST notation for a bullet item
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/CodeOfConflict | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/CodeOfConflict b/Documentation/CodeOfConflict
index 49a8ecc157a2..47b6de763203
Hi Punnaih,
On Sun, 23 Oct 2016 17:37:42 +0530
punnaiah choudary kalluri wrote:
> Hi Boris and Jason,
>
> I am doing rework on these patches to accommodate recent changes with
> respect to ooblayout. Also some of the comments that i have received
> from Boris as part of
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab :
> Convert adding-syscalls.txt to ReST markup and add it to the
> development-process book:
>
> - add extra lines to make Sphinx to correctly parse paragraphs;
> - use quote blocks for examples;
> - use monotonic
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab :
> - Fix document title;
> - use quote blocks where needed;
> - use monotonic fonts for config options and file names;
> - adjust whitespaces and blank lines;
> - add it to the user's book.
>
> Signed-off-by: Mauro
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab :
> - Fix identation for the document title;
> - use monotonic fonts for commands, paths, etc;
> - use quote blocks where needed;
> - adjust spaces to properly format paragraphs;
> - add it to the user book.
>
>
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
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab :
> - Add a document title;
> - use .. note:: markup;
> - use quote blocks where needed;
> - use monotonic fonts for config options and file names;
> - adjust whitespaces and blank lines;
> - replace _foo_ by **foo**;
On Friday, October 21, 2016 3:09:16 PM CEST Jonathan Corbet wrote:
> On Mon, 17 Oct 2016 16:26:23 +0100
> Punit Agrawal wrote:
>
> > The dma mapping api howto gives the impression that using the
> > dma_set_mask_and_coherent (and related DMA APIs) will cause the kernel
> >
On Mon, 24 Oct 2016, Markus Heiser wrote:
> again, sorry for nitpicking, IMO a blank line after each list item
> would make it more readable.
I think it's more important to agree on the high level changes in this
series. After a point it's more productive to just merge
Em Mon, 24 Oct 2016 17:27:31 +0200
Markus Heiser escreveu:
> Am 24.10.2016 um 17:00 schrieb Jani Nikula :
>
> > On Mon, 24 Oct 2016, Markus Heiser wrote:
> >> again, sorry for nitpicking, IMO a blank line
Am 24.10.2016 um 17:00 schrieb Jani Nikula :
> On Mon, 24 Oct 2016, Markus Heiser wrote:
>> again, sorry for nitpicking, IMO a blank line after each list item
>> would make it more readable.
>
> I think it's more important to agree on the
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab :
> Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters
> on an user's manual book.
>
> As we'll be numbering the user's manual, remove the manual
> numbering from SecurityBugs.
>
> Signed-off-by: Mauro
Em Mon, 24 Oct 2016 17:17:27 +0200
Markus Heiser escreveu:
> Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab
> :
>
> > Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters
> > on an user's manual book.
> >
> > As we'll be
... and move to Documentation/core-api folder.
Signed-off-by: Silvio Fricke
---
Documentation/core-api/index.rst | 2 +-
Documentation/core-api/workqueue.rst | 394 -
Documentation/index.rst | 1 +-
Signed-off-by: Silvio Fricke
---
Documentation/00-INDEX | 4 +++-
Documentation/core-api/conf.py | 5 +
Documentation/core-api/index.rst | 15 +++
Documentation/index.rst | 1 +
4 files changed, 24 insertions(+), 1 deletion(-)
Only formating changes.
Signed-off-by: Silvio Fricke
---
include/linux/workqueue.h | 30 +-
1 file changed, 21 insertions(+), 9 deletions(-)
diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
index fc6e221..afc1d46 100644
---
Hi,
v2 -> v3:
* Introduce a core-api folder
* move workqueue.rst to core-api
* reflect change in 00-index and workqueue.h
v1 -> v2:
* s/kernel-doc: $type_param takes care that this parameter is used for
formatting too.
* i/l/workqueue.h: inlining of documentation for workqueue_attrs struct
Without this patch we get warnings for named variable arguments.
warning: No description found for parameter '...'
warning: Excess function parameter 'args' description in
'alloc_ordered_workqueue'
Signed-off-by: Silvio Fricke
Reviewed-by: Jani Nikula
On Mon, 24 Oct 2016, Davidlohr Bueso wrote:
> Any comments? can this make it for v4.10?
We need to fry the futex/rtmutex fish first
--
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
- add a title for the document;
- convert the table;
- use quote block for the changelog;
- use monotonic fonts for file names;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/magic-number.txt |
- add a title for the document;
- convert some parameters to tables;
- use quote blocks where needed;
- use monotonic fonts for parameters;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/md.txt
- use a quote blocks where needed;
- fix the chapter/section/subsection markups;
- use ``foo`` for monotonic;
- use .. note:: for /sbin/init file permissions;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
- Add a document title;
- use quote blocks where needed;
- convert parameters to a nested table;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- replace _foo_ by **foo**;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
- Fix document title;
- use quote blocks where needed;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/java.txt | 244
Adjust the readme file for it to use the ReST markup:
- add chapter/section markups;
- use ``foo`` for commands;
- use :: for verbatim and script blocks;
- replace unsupported markup _foo_ by **foo**;
- add cross-references to other ReST files;
- use lower case on the section titles, to match
- Fix identation for the document title;
- use monotonic fonts for commands, paths, etc;
- use quote blocks where needed;
- adjust spaces to properly format paragraphs;
- add it to the user book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/binfmt_misc.txt |
As we'll type this a lot, after adding CodingStyle & friends,
let's rename the directory name to a shorter one.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/00-INDEX | 2 +-
Documentation/SubmittingPatches
- promote the section level of the document name;
- add/remove spaces/new lines where needed to format the output;
- use quote blocks.
- add it to the user book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/bad_memory.txt | 26 --
1
- use a quote blocks where needed;
- fix the chapter/section/subsection markups;
- use ``foo`` for monotonic;
- use .. note:: for the line-range note;
- cleanup whitespaces;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
- Fix document title;
- use quote blocks where needed;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/ramoops.txt | 86
- Fix identatio for the document title;
- remove its index;
- create a table for hash algorithm to be used;
- use quote blocks where needed;
- use monotonic fonts for parameters;
- adjust whitespaces and blank lines;
- Fix case on section titles;
- add it to the user's book.
Signed-off-by: Mauro
- Add a document title and remove its own index;
- use monotonic fonts for paths;
- use quote blocks where needed;
- adjust/use spaces to properly format paragraphs;
- add it to the user book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/BUG-HUNTING | 162
- Fix document title;
- use quote blocks where needed;
- use .. note:: for notes;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- add it to the user's book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/mono.txt
Joerg Roedel writes:
> On Fri, Oct 21, 2016 at 03:09:16PM -0600, Jonathan Corbet wrote:
>> On Mon, 17 Oct 2016 16:26:23 +0100
>> Punit Agrawal wrote:
>>
>> > The dma mapping api howto gives the impression that using the
>> > dma_set_mask_and_coherent
Am 24.10.2016 um 13:00 schrieb Mauro Carvalho Chehab :
> Those files got moved to Documentation/process, but as they're very
> well known files, add pointers to their new locations.
>
> PS.: I opted to not merge this patch with the previous one
> in order to make the
Hi Silvio,
> [...]
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 28a1ff6..7e1efa2 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -19,6 +19,7 @@ Contents:
> media/index
> gpu/index
> 80211/index
> + misc/index
The needs to be
... and move to Documentation/core-api folder.
Signed-off-by: Silvio Fricke
---
Documentation/core-api/index.rst | 2 +-
Documentation/core-api/workqueue.rst | 394 -
Documentation/workqueue.txt | 388
Signed-off-by: Silvio Fricke
---
Documentation/00-INDEX | 4 +++-
Documentation/core-api/conf.py | 5 +
Documentation/core-api/index.rst | 15 +++
Documentation/index.rst | 1 +
4 files changed, 24 insertions(+), 1 deletion(-)
Hi,
v3 -> v4:
* The outdated misc reference in D/index.rst was not removed
v2 -> v3:
* Introduce a core-api folder
* move workqueue.rst to core-api
* reflect change in 00-index and workqueue.h
v1 -> v2:
* s/kernel-doc: $type_param takes care that this parameter is used for
formatting too.
*
On 10/21/2016 4:33 PM, Yury Norov wrote:
All new 32-bit architectures should have 64-bit off_t type, but existing
architectures has 32-bit ones.
[...]
For syscalls sys_openat() and sys_open_by_handle_at() force_o_largefile()
is called, to set O_LARGEFILE flag, and this is the only difference
Only formating changes.
Signed-off-by: Silvio Fricke
---
include/linux/workqueue.h | 30 +-
1 file changed, 21 insertions(+), 9 deletions(-)
diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
index fc6e221..afc1d46 100644
---
Without this patch we get warnings for named variable arguments.
warning: No description found for parameter '...'
warning: Excess function parameter 'args' description in
'alloc_ordered_workqueue'
Signed-off-by: Silvio Fricke
Reviewed-by: Jani Nikula
Any comments? can this make it for v4.10?
Thanks,
Davidlohr
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
On Thu, 2016-10-20 at 10:29 -0600, Jonathan Corbet wrote:
> On Thu, 20 Oct 2016 18:22:28 +0200
> Oliver Neukum wrote:
>
> > > Why does this not remove the .tmpl file?
> >
> > 1. We might want to keep it
> > 2. It is an operation beyond the scope of this patch.
>
> I have
Em Mon, 24 Oct 2016 12:04:31 +0300
Jani Nikula escreveu:
> I think I saw some of this in the past [1], but then couldn't reproduce
> it after all. Now I'm seeing it again. Sporadically
> Documentation/media/uapi/cec/ gets rebuilt on successive runs of make
> htmldocs, even
Em Sun, 23 Oct 2016 17:18:02 +0200
Markus Heiser escreveu:
> Add a 'Install prerequisites' chapter and updated the 'Sphinx build' chapter.
Hmm... IMO, 'Install prerequisites' should be at Documentation/Changes.
Btw, I added that already, on one of my patches (pending
82 matches
Mail list logo