- 06 Feb, 2017 9 commits
-
-
Jonathan Corbet authored
It had gone stale, of course, as it would every year, a single date doesn't really cover things, and the date isn't really needed anyway.
-
Jonathan Corbet authored
An extra space in the wrong place made Sphinx unhappy; take it out. Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Rafael J. Wysocki authored
Move the document describing PM notifiers (used during system sleep state transitions) to Documentation/driver-api/pm/, convert it to reST and update it to use current terminology. Also replace the remaining references to the old version of it in .txt documents with references to the new one. Signed-off-by:
Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Rafael J. Wysocki authored
Move the document describing the system sleep state transitions API for devices to Documentation/driver-api/pm/, convert it to reST and update it to use current terminology. Also remove the remaining reference to the old version of it from pm.h. The new document still contains references to some documents in the .txt format that will be converted later. Signed-off-by:
Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Rafael J. Wysocki authored
Refresh the struct dev_pm_ops kerneldoc comment, so that it looks better and is more readable after processing by Sphinx, and drop the kerneldoc marker from a few other comments ("PM_EVENT_ messages" and a couple of enum types declarations) which are not proper kerneldoc and generally confuse Sphinx. Also change the comment describing struct dev_pm_domain into a kerneldoc one. Signed-off-by:
Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Jonathan Corbet authored
Ben writes: "This series fixes some bugs I found in the new doc build system."
-
Ben Hutchings authored
In any case where we recurse but don't mention $(MAKE) literally in the recipe, we need to add a '+' at the start of the command to ensure that parallel makes and various other options work properly. Fixes: 609afe6b ("Documentation/sphinx: build the media intermediate ...") Tested-by:
Markus Heiser <markus.heiser@darmarit.de> Signed-off-by:
Ben Hutchings <ben@decadent.org.uk> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Ben Hutchings authored
As we use redirection to create the SVG file, even a failed conversion will create the file and 'make' will consider it up-to-date if the build is retried. We should delete it in case of failure. Fixes: ec868e4e ("docs-rst: media: build SVG from graphviz files") Signed-off-by:
Ben Hutchings <ben@decadent.org.uk> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Ben Hutchings authored
As $(SHELL) doesn't include the -e option, any loop or other sequence needs to include explicit checks for failing commands. Fixes: 609afe6b ("Documentation/sphinx: build the media intermediate ...") Fixes: 606b9ac8 ("doc-rst: generic way to build only sphinx sub-folders") Fixes: cd21379b ("doc-rst: generic way to build PDF of sub-folders") Tested-by:
Markus Heiser <markus.heiser@darmarit.de> Signed-off-by:
Ben Hutchings <ben@decadent.org.uk> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 01 Feb, 2017 5 commits
-
-
Jani Nikula authored
Make targets that don't depend on Sphinx work without warnings about missing Sphinx. 'make cleandocs' will work without Sphinx just fine, and the targets that are no-ops for Sphinx should just be skipped. Move them outside of the HAVE_SPHINX checks to take precedence over the .DEFAULT target for HAVE_SPHINX=0. Reported-by:
Jim Davis <jim.epost@gmail.com> Reference: http://lkml.kernel.org/r/CA+r1ZhjRVqkjPXGOGB_BOAX2Hkfb+qQCtTzFfBMFeH1Mfeej7w@mail.gmail.comSigned-off-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Markus Heiser authored
The cleandocs target won't work if I use a different output folder:: $ make O=/tmp/kernel SPHINXDIRS="process" cleandocs make[1]: Entering directory '/tmp/kernel' make[3]: *** No rule to make target 'clean'. Stop. ... Documentation/Makefile.sphinx:100: recipe for target 'cleandocs' failed Signed-off-by:
Markus Heiser <markus.heiser@darmarit.de> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Jani Nikula authored
Use PYTHONDONTWRITEBYTECODE=1 to prevent python from creating .pyc files in the source tree. Python 3.2 has a __pycache__ scheme [1], but before that the only alternative seems to be to copy the source files to the build tree to ensure the .pyc files are created there too. Just prevent .pyc file generation for simplicity. Considering the small amount of python code to compile (assuming sphinx itself has .pyc around), the impact on build is neglible. [1] http://stackoverflow.com/questions/3522079/changing-the-directory-where-pyc-files-are-created References: http://lkml.kernel.org/r/CAMuHMdVxqpH7-9XJ+YE_pgoA+-fe0969cSkOehYh3uubYcrhZA@mail.gmail.comReported-by:
Geert Uytterhoeven <geert@linux-m68k.org> References: http://lkml.kernel.org/r/1485816692.2900.17.camel@decadent.org.ukReported-by:
Ben Hutchings <ben@decadent.org.uk> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Jonathan Corbet authored
A fairly straightforward conversion to RST; the document is then added to the driver-api manual. Of course, this document has seen no substantive changes since 2008, so chances are it needs work in other areas as well. Cc: Mark Brown <broonie@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Jonathan Corbet authored
Convert deviceiobook.tmpl to RST and incorporate it into the driver API manual. Like the rest of our documentation, this one could use some work. There's no mention of ioremap() and friends, no mention of io_read*() and friends. But we have nice documentation for all those folks writing new drivers that do port I/O :). The :c:func: notation has been left off of all the read*/write* functions. There's no kerneldoc comments for them anyway, so those links will never be live, and writing a bunch of repetitive "read a byte from I/O memory" comments lacks appeal. Cc: Matthew Wilcox <willy@infradead.org> Cc: Alan Cox <gnomes@lxorguk.ukuu.org.uk> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 26 Jan, 2017 7 commits
-
-
Andy Deng authored
Tested by the command: make htmldocs During the compiling process, zh_CN/coding-style.rst has no errors and warnings generated, the generated html document has been checked. Signed-off-by:
Andy Deng <theandy.deng@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Andy Deng authored
This commit applies all changes from the English version, and should be able to work with the documentation build system. Signed-off-by:
Andy Deng <theandy.deng@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Andy Deng authored
Some of the sentences in Chapters 19 and 20 are re-translated: - Fixed translation errors in Section 2 of Chapter 19 to prevent misleading readers; - Retranslate some sentences to make the translation more clear and accurate. Signed-off-by:
Andy Deng <theandy.deng@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Masanari Iida authored
This patch fix some double words found in Documentation. Signed-off-by:
Masanari Iida <standby24x7@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Matthew Wilcox authored
Clearly nobody ever tried to build the documentation for the radix tree before: include/linux/radix-tree.h:400: warning: cannot understand function prototype: 'void ** radix_tree_iter_init(struct radix_tree_iter *iter, unsigned long start) ' Indeed, the regexes only handled a single '*', not one-or-more. I have tried to fix that, but now I have perl regexes all over my hands, and I fear I shall never be clean again. Signed-off-by:
Matthew Wilcox <mawilcox@microsoft.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Steven Price authored
Two of the example command lines use an argument to echo of "-c" which isn't valid in (most versions of) echo causing these examples to fail. Correct the argument to "-n" which works correctly. Signed-off-by:
Steven Price <steven@ecrips.co.uk> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Florian Fainelli authored
Add a bunch of entries reflective of programs that the kernel build: sortextable, dtc. And while at it, expand the lex*.c entries to cover e.g: dtc-lexer.c. Finally, exclude devicetable-offsets.h Signed-off-by:
Florian Fainelli <f.fainelli@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 13 Jan, 2017 4 commits
-
-
W. Trevor King authored
This looks like it was accidentally caught up in e21a05cb (doc: cpuset: Update the cpuset flag file, 2010-02-24). While I'm touching the line, also fix the posessive "cpusets" -> "cpuset's". Signed-off-by:
W. Trevor King <wking@tremily.us> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Sanjeev authored
... and a minor missing period at EOL Signed-off-by:
Sanjeev Gupta <ghane0@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Gabriel Krisman Bertazi authored
Documentation for array parameters passed in a function, like the first argument in the function below, weren't getting exported in the rst format, although they work fine for html and pdf formats: void drm_clflush_pages(struct page * pages[], unsigned long num_pages) That's because the string key to store the description in the parameterdescs dictionary doesn't have the [] suffix. This cleans up the suffix from the key before accessing the dictionary. Signed-off-by:
Gabriel Krisman Bertazi <krisman@collabora.co.uk> Fixes: c0d1b6ee ("kernel-doc: produce RestructuredText output") Reviewed-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Sebastian Andrzej Siewior authored
The current CPU hotplug is outdated. During the update to what we currently have I rewrote it partly and moved to sphinx format. Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Rusty Russell <rusty@rustcorp.com.au> Cc: Srivatsa Vaddagiri <vatsa@in.ibm.com> Cc: Ashok Raj <ashok.raj@intel.com> Cc: Joel Schopp <jschopp@austin.ibm.com> Cc: linux-doc@vger.kernel.org Signed-off-by:
Sebastian Andrzej Siewior <bigeasy@linutronix.de> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 04 Jan, 2017 11 commits
-
-
Paolo Bonzini authored
$type_struct_full and friends are only used by the restructuredText backend, because it needs to separate enum/struct/typedef/union from the name of the type. However, $type_struct is *also* used by the rST backend. This is confusing. This patch replaces $type_struct's use in the rST backend with a new $type_fallback; it modifies $type_struct so that it can be used in the rST backend; and creates regular expressions like $type_struct for enum/typedef/union, for use in all backends. Note that, compared to $type_*_full, in the new regexes $1 includes both the "kind" and the name (before, $1 was pretty much a constant). Signed-off-by:
Paolo Bonzini <pbonzini@redhat.com> Acked-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Paolo Bonzini authored
Note that, in order to produce the correct Docbook markup, the "." or "->" must be separated from the member name in the regex's captured fields. For consistency, this change is applied to $type_member and $type_member_func too, not just to $type_member_xml. List mode only prints the struct name, to avoid any undesired change in the operation of docproc. Signed-off-by:
Paolo Bonzini <pbonzini@redhat.com> Acked-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Paolo Bonzini authored
The restructuredText output includes both the parameter type and the name for functions and function-typed members. Do the same for docbook. Signed-off-by:
Paolo Bonzini <pbonzini@redhat.com> Acked-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Paolo Bonzini authored
An inline function can have an attribute, as in include/linux/log2.h, and kernel-doc handles this already for simple cases. However, some attributes have arguments (e.g. the "target" attribute). Handle those too. Furthermore, attributes could be at the beginning of a function declaration, before the return type. To correctly handle this case, you need to strip spaces after the attributes; otherwise, dump_function is left confused. Signed-off-by:
Paolo Bonzini <pbonzini@redhat.com> Acked-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Paolo Bonzini authored
A prototype like /** * foo - sample definition * @bar: a parameter */ int foo(int (*bar)(int x, int y)); is currently producing .. c:function:: int foo (int (*bar) (int x, int y) sample definition **Parameters** ``int (*)(int x, int y) bar`` a parameter Collapse the spaces so that the output is nicer. Signed-off-by:
Paolo Bonzini <pbonzini@redhat.com> Acked-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Sanjeev authored
Even though the jitter due to USB1.1 may be 1ms, NTP can reduce its effect significantly. And USB2.0 reduces this anyway. Signed-off-by:
Sanjeev Gupta <ghane0@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Sanjeev authored
No semantic changes. The next patch in this series will do the actual changes to sync with NTP current best practices Signed-off-by:
Sanjeev Gupta <ghane0@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Sanjeev authored
timepps.h , as well as PPS sample test utilities, are no longer in the kernel tree. Update documentation to point to new locations. Signed-off-by:
Sanjeev Gupta <ghane0@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Colin Ian King authored
Signed-off-by:
Colin Ian King <colin.king@canonical.com> Acked-by:
Guenter Roeck <linux@roeck-us.net> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Shilpasri G Bhat authored
Documentation: cpufreq: Update supported powernv processors Signed-off-by:
Shilpasri G Bhat <shilpa.bhat@linux.vnet.ibm.com> Acked-by:
Viresh Kumar <viresh.kumar@linaro.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Jonathan Cameron authored
This is a manual conversion of the existing DocBook documentation for IIO. The intent is not to substantially change any of the content in this patch, but to give a base to build upon. Signed-off-by:
Jonathan Cameron <jic23@kernel.org> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 27 Dec, 2016 3 commits
-
-
Cihangir Akturk authored
In the actual implementation ether_addr_equal function tests for equality to 0 when returning. It seems in commit 0d74c4 it is somehow overlooked to change this operator to reflect the actual function. Signed-off-by:
Cihangir Akturk <cakturk@gmail.com> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
John Brooks authored
The 80211.tmpl DocBook file was removed in commit 819bf593 ("docs-rst: sphinxify 802.11 documentation"), but the 80211.xml target was re-added to the Makefile by commit 7ddedebb ("ALSA: doc: ReSTize writing-an-alsa-driver document"), leading to a failure when building the documentation: *** No rule to make target 'Documentation/DocBook/80211.xml', needed by 'Documentation/DocBook/80211.aux.xml'. cc: stable@vger.kernel.org Signed-off-by:
John Brooks <john@fastquake.com> Mea-culpa-by:
Jonathan Corbet <corbet@lwn.net> Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Jonathan Corbet authored
Linux 4.10-rc1
-
- 26 Dec, 2016 1 commit
-
-
Linus Torvalds authored
-