On 15/09/16 06:06, Reza Arbab wrote:
> Respect the standard dt "status" property when scanning memory nodes in
> early_init_dt_scan_memory(), so that if the property is present and not
> "okay", no memory will be added.
>
> The use case at hand is accelerator or device memory, which may be
> unu
- Fix chapter identation inconsistencies;
- Convert table to ReST format;
- use the right tag for bullets;
- Fix bold emphasis;
- mark blocks with :: tags;
- use verbatim font for files;
- make Sphinx happy
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/Changes | 224
As we're about to use those two markups, add them to the
theme style overrride.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/sphinx-static/theme_overrides.css | 15 ++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/Documentation/sphinx-static/theme_overrides
That's the 4th version of this series. It also contains a second patch series
with more ReST conversions and documentation improvements.
This patchset merges the content of a second patch series:
[PATCH 00/17] Improve documentation for the development-process
I opted to keep the patch cha
- use the correct markup to identify each section;
- Add some blank lines for Sphinx to properly interpret
the markups;
- Remove a blank space on some paragraphs;
- Fix the verbatim and bold markups;
- Cleanup the remaining errors to make Sphinx happy.
Signed-off-by: Mauro Carvalho Chehab
-
This document is almost compliant with ReST notation, but some
small adjustments are needed to make it parse properly by
Sphinx (mostly, add blank lines where needed).
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/HOWTO | 53 +
1 file
Now that the documents were converted, rename them to .rst, as
this is needed by the Sphinx build logic.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/development-process/{1.Intro => 1.Intro.rst}| 0
Documentation/development-process/{2.Process => 2.Process.rst}
Now that the files at Documentation/development-process/
were converted to ReST, make create a book at Sphinx.
As we'll have other books related to the development process,
we'll add it as a sub-book.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/conf.py | 2 ++
As discussed at linux-doc ML, the best is to keep all documents
backward compatible with Sphinx version 1.2, as it is the latest
version found on some distros like Debian.
All books currently support it.
Please notice that, while it mentions the eventual need of
XeLaTex and texlive to build pdf f
- Change the document title markup to make it on a higher level;
- Add blank lines as needed, to improve the output;
- use italics for the country-code at kernel.org ftp URL.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/SubmittingDrivers | 45 -
Do a few changes to make the output look better:
- use bullets on trivial patches list;
- use monotonic font for tools name;
- use :manpage:`foo` for man pages;
- don't put all references to maintainer*html at the same line.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/SubmittingPatch
- Convert document name to ReST;
- Convert footnotes;
- Convert sections to ReST format;
- Don't use _foo_, as Sphinx doesn't support underline. Instead,
use bold;
- While here, remove whitespaces at the end of lines.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/ManagementStyle | 154
Add a name for the document and convert the sections to
ReST markups.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/SecurityBugs | 6 ++
1 file changed, 6 insertions(+)
diff --git a/Documentation/SecurityBugs b/Documentation/SecurityBugs
index a660d494c8ed..10a1f79376a2 100644
---
On Sphinx/ReST notation, ``foo`` means that foo will be will be
marked as inline literal, effectively making it to be presented
as a monospaced font.
As we want this document to be parsed by Sphinx, instead of using
"foo", use ``foo`` for the names that are literal, because it is an
usual typograp
- use ReST markups for section headers;
- add cross-references to the options;
- mark code blocks;
- a few minor changes to make Sphinx happy.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/stable_kernel_rules.txt | 101 +++---
1 file changed, 68 insertions(+)
Add cross references for the documents mentioned at HOWTO and
are under the Documentation/ directory, using the ReST notation.
It should be noticed that HOWTO also mentions the /README file.
We opted to not touch it, for now, as making it build on
Sphinx would require it to be moved to a Documenta
Task 11 (kernel-doc) still mentions usage of make manpages, but
this won't work if the API is documented via Sphinx. So, update
it to use either htmldocs or pdfdocs, with are the documentation
targets that work for all.
While here, add ReST reference to the kernel documentation book.
Signed-off-b
The description there are pre-Sphinx. Update it to cover the
new way.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/HOWTO | 28 ++--
1 file changed, 22 insertions(+), 6 deletions(-)
diff --git a/Documentation/HOWTO b/Documentation/HOWTO
index 31c8df5d20c7..f297d
As this file is mentioned at the development-process/ book,
let's convert it to ReST markup.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/SubmittingPatches | 2 +-
Documentation/development-process/5.Posting.rst | 2 +-
Documentation/email-clients.txt
- Fix all chapter identation;
- add c blocks where needed;
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/CodingStyle | 257 --
1 file changed, 180 insertions(+), 77 deletions(-)
diff --git a/Documentation/CodingStyle b/Documentation/CodingSty
Do a series of minor improvements at the ReST output format:
- Instead of using the quote blocks (::) for quotes, use
italics. That looks nicer on epub (and html) output, as
no scroll bar will be added. Also, it will adjust line
breaks on the text automatically.
- Add a missing reference to Submi
Sphinx doesn't accept underline markups by purpose.
While there are ways to support underline via CSS, this won't
be portable with non-html outputs.
As we want CodingStyle to do emphasis, replace _foo_ by **foo**,
using bold emphasis.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/Codin
This document is old: it is from Kernel v2.6.12 days.
Update it to the current status, and add a reference for the
linux-next tree.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/applying-patches.txt | 255 -
1 file changed, 110 insertions(+), 145 dele
This document is on good shape for ReST: all it was needed was
to fix the section markups, add a toctree, convert the tables
and add a few code/quote blocks.
While not strictly required, I opted to use lowercase for
the titles, just like the other books that were converted
to Sphinx.
Signed-off-b
Add markups for it to be properly parsed by Sphinx.
As people browsing this document may not notice that the source
file title is "stable_api_nonsense", I opted to use bold to
the rationale for this document. I also found it better to
add a note when it says that the nonsense applies only to the
k
- A few link references were missing http://
- Several sites are now redirecting to https protocol. On such
cases, just use the https URL.
NOTE: all URLs were checked and they're pointing to the right places.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/HOWTO | 37 +-
- use ``foo`` to markup inline literal stuff, effectively making it
to be presented as a monospaced font when parsed by Sphinx;
- the markup below the title should have the same length as the
title;
- Fix the list markups, from "1:" to "1)";
- Split item 2 into a separate list for the build
- Change the sections to use ReST markup;
- Add cross-references where needed;
- convert aspas to verbatim text;
- use code block tags;
- make Sphinx happy.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/SubmittingPatches | 207
1 file changed, 10
There are two places there where there are notes that should
be highlighted. So, use the ReST note markup for such texts.
Signed-off-by: Mauro Carvalho Chehab
---
Documentation/CodingStyle | 14 +-
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/Documentation/CodingStyl
Hi Mauro,
sorry for my late reply (so much work to do) ..
Am 09.09.2016 um 14:25 schrieb Markus Heiser :
>> Using either this approach or my kernel-doc patch, I'm now getting
>> only two warnings:
>>
>> 1) at media-entity.h, even without nitpick mode:
>>
>> ./include/media/media-entity.h:1053
On 15/09/16 06:06, Reza Arbab wrote:
> Remove the check which prevents us from hotplugging into an empty node.
>
> This limitation has been questioned before [1], and judging by the
> response, there doesn't seem to be a reason we can't remove it. No issues
> have been found in light testing.
>
On Mon, Sep 19, 2016 at 11:37 AM, Jean Delvare wrote:
> Hi Ilya,
>
> Sorry for the late answer.
>
> On Tue, 13 Sep 2016 20:31:57 +0200, Ilya Dryomov wrote:
>> Sorry, navigating lkml.org archive is a pain, and I was expecting to
>> see patch. Your points
>>
>> "The acceptance of an optional single
On Wed, 2016-09-14 at 12:36 +0530, Parav Pandit wrote:
> Hi Dennis,
>
> Do you know how would HFI1 driver would work along with rdma cgroup?
Keep in mind HFI1 driver has two "modes" of operation. We support
verbs, and would surely fall in line with whatever cgroups do for IB
core. For our psm int
Move runnable examples code from Documentation to samples. I moved
just the example code, and left documentation files as is.
blackfin gptimers example code needs a bit of special handling since
it is a module. I will address it in a separate patch. 00-Index files
need to be updated due to this mo
Move auxdisplay examples to samples and remove it from Documentation
Makefile. Create a new Makefile to build auxdisplay. It can be built
from top level directory or from auxdisplay directory:
Run make -C samples/auxdisplay or cd samples/auxdisplay; make
Signed-off-by: Shuah Khan
---
Documentat
Move timers examples to samples and remove it from Documentation
Makefile. Create a new Makefile to build timers. It can be built
from top level directory or from timers directory:
Run make -C samples/timers or cd samples/timers; make
Signed-off-by: Shuah Khan
---
Documentation/Makefile
Move misc-devices/mei examples to samples/mei and remove it from
Documentation Makefile. Delete misc-devices/Makefile.
Create a new Makefile to build samples/mei. It can be built from top
level directory or from mei directory:
Run make -C samples/mei or cd samples/mei; make
Signed-off-by: Shuah
Move watchdog examples to samples and remove it from Documentation
Makefile. Create a new Makefile to build watchdog. It can be built
from top level directory or from watchdog directory:
Run make -C samples/watchdog or cd samples/watchdog; make
Signed-off-by: Shuah Khan
---
Documentation/Makefi
Move laptops examples to samples and remove it from Documentation
Makefile. Create a new Makefile to build laptops. It can be built
from top level directory or from laptops directory:
Run make -C samples/laptops or cd samples/laptops; make
Signed-off-by: Shuah Khan
---
Documentation/Makefile
Move pcmcia examples to samples and remove it from Documentation
Makefile. Create a new Makefile to build pcmcia. It can be built
from top level directory or from pcmcia directory:
Run make -C samples/pcmcia or cd samples/pcmcia; make
Signed-off-by: Shuah Khan
---
Documentation/Makefile
Move accounting examples to samples and remove it from Documentation
Makefile. Create a new Makefile to build accounting. It can be built
from top level directory or from accounting directory:
Run make -C samples/accounting or cd samples/accounting; make
Signed-off-by: Shuah Khan
---
Documentat
Em Mon, 19 Sep 2016 13:36:55 +0200
Markus Heiser escreveu:
> Hi Mauro,
>
> sorry for my late reply (so much work to do) ..
>
> Am 09.09.2016 um 14:25 schrieb Markus Heiser :
>
> >> Using either this approach or my kernel-doc patch, I'm now getting
> >> only two warnings:
> >>
> >> 1) at medi
On 2016-09-14 05:12 AM, Michal Hocko wrote:
On Tue 13-09-16 13:27:39, Sonny Rao wrote:
On Tue, Sep 13, 2016 at 12:12 AM, Michal Hocko wrote:
On Mon 12-09-16 10:28:53, Sonny Rao wrote:
On Mon, Sep 12, 2016 at 10:15 AM, Michal Hocko wrote:
On Mon 12-09-16 08:31:36, Sonny Rao wrote:
[...]
On Mon, 19 Sep 2016, Shuah Khan wrote:
> Move runnable examples code from Documentation to samples. I moved
> just the example code, and left documentation files as is.
FWIW I like this.
BR,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the li
On Mon, 19 Sep 2016 08:47:32 -0600
Shuah Khan wrote:
> Move accounting examples to samples and remove it from Documentation
> Makefile. Create a new Makefile to build accounting. It can be built
> from top level directory or from accounting directory:
So I like the basic idea of these patches; i
On Mon, 19 Sep 2016 08:47:33 -0600
Shuah Khan wrote:
> Move auxdisplay examples to samples and remove it from Documentation
> Makefile. Create a new Makefile to build auxdisplay. It can be built
> from top level directory or from auxdisplay directory:
Documentation/auxdisplay/cfag12864b needs to
On Mon, 19 Sep 2016 08:47:34 -0600
Shuah Khan wrote:
> Move laptops examples to samples and remove it from Documentation
> Makefile. Create a new Makefile to build laptops. It can be built
> from top level directory or from laptops directory:
This one might be better called a "tool" rather than
On Mon, 19 Sep 2016 08:47:35 -0600
Shuah Khan wrote:
> Move mic/mpssd examples to samples and remove it from Documentation
> Makefile. Create a new Makefile to build mic/mpssd. It can be built
> from top level directory or from mic/mpssd directory:
>
> Run make -C samples/mic/mpssd or cd samples
On Mon, 19 Sep 2016 08:47:36 -0600
Shuah Khan wrote:
> Move misc-devices/mei examples to samples/mei and remove it from
> Documentation Makefile. Delete misc-devices/Makefile.
>
> Create a new Makefile to build samples/mei. It can be built from top
> level directory or from mei directory:
This
On Mon, 19 Sep 2016 08:47:37 -0600
Shuah Khan wrote:
> Move pcmcia examples to samples and remove it from Documentation
> Makefile. Create a new Makefile to build pcmcia. It can be built
> from top level directory or from pcmcia directory:
Does PCMCIA still exist/work? I guess it probably must
On Mon, 19 Sep 2016 08:47:38 -0600
Shuah Khan wrote:
> Move timers examples to samples and remove it from Documentation
> Makefile. Create a new Makefile to build timers. It can be built
> from top level directory or from timers directory:
Documentation/timers/hpet.txt needs updating. Otherwise
On Mon, 19 Sep 2016 08:47:39 -0600
Shuah Khan wrote:
> Move watchdog examples to samples and remove it from Documentation
> Makefile. Create a new Makefile to build watchdog. It can be built
> from top level directory or from watchdog directory:
Updates needed to watchdog-api.txt and wdt.txt; pr
Hi Denny,
On Mon, Sep 19, 2016 at 6:40 PM, Dalessandro, Dennis
wrote:
> On Wed, 2016-09-14 at 12:36 +0530, Parav Pandit wrote:
>> Hi Dennis,
>>
>> Do you know how would HFI1 driver would work along with rdma cgroup?
>
> Keep in mind HFI1 driver has two "modes" of operation. We support
> verbs, an
Changeset ab6343956f9c ("[media] V4L2: Add documentation for SDI timings
and related flags") added documentation for new V4L2 defines, but
it forgot to update videodev2.h.rst.exceptions to point to where
the documentation for those new values will be inside the book,
causing those warnings:
Do
On 09/19/2016 07:32 PM, Mauro Carvalho Chehab wrote:
> Changeset ab6343956f9c ("[media] V4L2: Add documentation for SDI timings
> and related flags") added documentation for new V4L2 defines, but
> it forgot to update videodev2.h.rst.exceptions to point to where
> the documentation for those new va
This is an automatic generated email to let you know that the following patch
were queued:
Subject: MAINTAINERS: update documentation for media subsystem
Author: Mauro Carvalho Chehab
Date:Mon Sep 12 12:48:54 2016 -0300
With ReST conversion, the media subsystem documentation is now
located
On Mon 19-09-16 11:16:31, Robert Foss wrote:
> On 2016-09-14 05:12 AM, Michal Hocko wrote:
> > On Tue 13-09-16 13:27:39, Sonny Rao wrote:
[...]
> > > Given that smaps
> > > doesn't provide this in a straightforward way, what do you think is
> > > the right way to provide this information?
> >
> >
> Documentation/auxdisplay/cfag12864b needs to be updated to reflect the new
> home for the program (which probably does belong in samples/).
>
> I wonder if these programs need MAINTAINERS entries too?
Do you find any more update suggestions interesting around this software module?
https://patch
On Mon, Sep 19, 2016 at 09:51:13PM +0200, Michal Hocko wrote:
> [not sure why the CC list was trimmed - do no do that please unless you
> have a strong reason for that - if this was not intentional please
> restpre it]
Ah, sorry, pressed the wrong key.
> On Mon 19-09-16 21:40:01, Jann Horn wro
On Mon, Sep 19, 2016 at 12:56 PM, Jann Horn wrote:
> On Mon, Sep 19, 2016 at 09:51:13PM +0200, Michal Hocko wrote:
>> [not sure why the CC list was trimmed - do no do that please unless you
>> have a strong reason for that - if this was not intentional please
>> restpre it]
>
> Ah, sorry, presse
On Mon, Sep 19, 2016 at 01:53:37PM +0200, Ilya Dryomov wrote:
> > I did consider the reason to be good enough to warrant a "change",
> > actually. Or more exactly from "one space is allowed" to "one space is
> > recommended." Which is quite different from changing all the code
> > actively. I can u
On 2016-09-19 03:32 PM, Michal Hocko wrote:
On Mon 19-09-16 11:16:31, Robert Foss wrote:
On 2016-09-14 05:12 AM, Michal Hocko wrote:
On Tue 13-09-16 13:27:39, Sonny Rao wrote:
[...]
Given that smaps
doesn't provide this in a straightforward way, what do you think is
the right way to provide
On Mon, Sep 19, 2016 at 5:27 PM, Robert Foss wrote:
>
>
> On 2016-09-19 03:32 PM, Michal Hocko wrote:
>>
>> On Mon 19-09-16 11:16:31, Robert Foss wrote:
>>>
>>> On 2016-09-14 05:12 AM, Michal Hocko wrote:
On Tue 13-09-16 13:27:39, Sonny Rao wrote:
>>
>> [...]
>
> Given that smaps
The dots at the ends of the list elements introduced
unnecesarry newlines in the "compiled" document.
Example:
(https://mchehab.fedorapeople.org/development-process/latex/development-process.pdf)
While this was not "mission critical" it's not nice to look at
either.
Signed-off-by: Richard Sailer
This introduces a consistent indenting of 4 spaces for all
lists.
Signed-off-by: Richard Sailer
---
Documentation/development-process/kernel-docs.rst | 1252 ++---
1 file changed, 626 insertions(+), 626 deletions(-)
diff --git a/Documentation/development-process/kernel-docs.rst
Background/Reasoning:
Books:
--
* Linux Kernel Networking by Rami Rosen
While some parts are quite short and could be
more carefully explained it's still a good recomendation
for understanding linux kernel networking, (IMHO)
* Linux Treiber entwickeln:
It sure is a drawback that t
I think kernel-docs.rst should be kept. (Or at least another/updated
file fullfilling this purpose should exist) Therefore I put
some effort into updating it.
This patch relies on Mauros:
[Patch v2 ...] Create a book for Kernel development
Summary
---
This patch:
* Removes all the de
Em Tue, 20 Sep 2016 02:40:21 +0200
Richard Sailer escreveu:
> I think kernel-docs.rst should be kept. (Or at least another/updated
> file fullfilling this purpose should exist) Therefore I put
> some effort into updating it.
>
> This patch relies on Mauros:
>[Patch v2 ...] Create a book fo
On Tue, 2016-09-20 at 01:11 +0100, Al Viro wrote:
> IMO what we need is to go through all rules in CodingStyle and if for
> some rule there is no overwhelming majority in the core kernel, well,
> the list has grown way too large and could use massive trimming.
I'm in complete agreement.
I also th
This patch fix typos "the the" found in Documentation/filesystems.
Signed-off-by: Masanari Iida
---
Documentation/filesystems/autofs4-mount-control.txt | 10 +-
Documentation/filesystems/directory-locking | 2 +-
Documentation/filesystems/overlayfs.txt | 2 +-
3 fil
On Mon, 19 Sep 2016, Joe Perches wrote:
> On Tue, 2016-09-20 at 01:11 +0100, Al Viro wrote:
> > IMO what we need is to go through all rules in CodingStyle and if for
> > some rule there is no overwhelming majority in the core kernel, well,
> > the list has grown way too large and could use massi
> -Original Message-
> From: Jonathan Corbet [mailto:cor...@lwn.net]
> Sent: Monday, September 19, 2016 19:14
> To: Shuah Khan
> Cc: Dutt, Sudeep ; Dixit, Ashutosh
> ; Winkler, Tomas ;
> t...@linutronix.de; w...@iguana.be; li...@roeck-us.net;
> elfr...@users.sourceforge.net; nicolas.dich
On Tue, 2016-09-20 at 07:53 +0200, Julia Lawall wrote:
> On Mon, 19 Sep 2016, Joe Perches wrote:
> > On Tue, 2016-09-20 at 01:11 +0100, Al Viro wrote:
> > > IMO what we need is to go through all rules in CodingStyle and if for
> > > some rule there is no overwhelming majority in the core kernel, we
On Mon, 19 Sep 2016, Joe Perches wrote:
> On Tue, 2016-09-20 at 07:53 +0200, Julia Lawall wrote:
> > On Mon, 19 Sep 2016, Joe Perches wrote:
> > > On Tue, 2016-09-20 at 01:11 +0100, Al Viro wrote:
> > > > IMO what we need is to go through all rules in CodingStyle and if for
> > > > some rule the
74 matches
Mail list logo
