Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d6a24d06 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-for-linus' of git://git.lwn.net/linux-2.6 

Pull documentation updates from Jonathan Corbet:
 "Numerous fixes, the overdue removal of the i2o docs, some new Chinese
  translations, and, hopefully, the README fix that will end the flow of
  identical patches to that file"

* tag 'docs-for-linus' of git://git.lwn.net/linux-2.6: (34 commits)
  Documentation/memcg: update memcg/kmem status
  Documentation: blackfin: Makefile: Typo building issue
  Documentation/vm/pagemap.txt: correct location of page-types tool
  Documentation/memory-barriers.txt: typo fix
  doc: Add guest_nice column to example output of `cat /proc/stat'
  Documentation/kernel-parameters: Move "eagerfpu" to its right place
  Documentation: gpio: Update ACPI part of the document to mention _DSD
  docs/completion.txt: Various tweaks and corrections
  doc: completion: context, scope and language fixes
  Documentation:Update Documentation/zh_CN/arm64/memory.txt
  Documentation:Update Documentation/zh_CN/arm64/booting.txt
  Documentation: Chinese translation of arm64/legacy_instructions.txt
  DocBook media: fix broken EIA hyperlink
  Documentation: tweak the maintainers entry
  README: Change gzip/bzip2 to xz compression format
  README: Update version number reference
  doc:pci: Fix typo in Documentation/PCI
  Documentation: drm: Use '->' when describing access through pointers.
  Documentation: Remove mentioning of block barriers
  Documentation/email-clients.txt: Fix one grammar mistake, add extra info about TB
  ...
parents 1f5014d6 19717542

Documentation/CodingStyle

+76 −73
Original line number Diff line number Diff line
@@ -56,7 +56,6 @@ instead of "double-indenting" the "case" labels. E.g.: 
		break;

	}





Don't put multiple statements on a single line unless you have

something to hide:
@@ -186,8 +185,11 @@ although they are not required in the language, as in: "sizeof info" after 
"struct fileinfo info;" is declared).



So use a space after these keywords:



	if, switch, case, for, do, while



but not with sizeof, typeof, alignof, or __attribute__.  E.g.,



	s = sizeof(struct file);



Do not add spaces around (inside) parenthesized expressions.  This example is
@@ -209,12 +211,15 @@ such as any of these: 
	=  +  -  <  >  *  /  %  |  &  ^  <=  >=  ==  !=  ?  :



but no space after unary operators:



	&  *  +  -  ~  !  sizeof  typeof  alignof  __attribute__  defined



no space before the postfix increment & decrement unary operators:



	++  --



no space after the prefix increment & decrement unary operators:



	++  --



and no space around the '.' and "->" structure member operators.
@@ -268,13 +273,11 @@ See chapter 6 (Functions). 
		Chapter 5: Typedefs



Please don't use things like "vps_t".



It's a _mistake_ to use typedef for structures and pointers. When you see a



	vps_t a;



in the source, what does it mean?



In contrast, if it says



	struct virtual_container *a;

Documentation/DocBook/drm.tmpl

+1 −1
Original line number Diff line number Diff line
@@ -1293,7 +1293,7 @@ int max_width, max_height;</synopsis> 
          </para>

          <para>

            If a page flip can be successfully scheduled the driver must set the

            <code>drm_crtc-&lt;fb</code> field to the new framebuffer pointed to

            <code>drm_crtc-&gt;fb</code> field to the new framebuffer pointed to

            by <code>fb</code>. This is important so that the reference counting

            on framebuffers stays balanced.

          </para>

Documentation/DocBook/media/v4l/biblio.xml

+5 −6
Original line number Diff line number Diff line 
  <bibliography>

    <title>References</title>



    <biblioentry id="eia608">

      <abbrev>EIA&nbsp;608-B</abbrev>

    <biblioentry id="cea608">

      <abbrev>CEA&nbsp;608-E</abbrev>

      <authorgroup>

	<corpauthor>Electronic Industries Alliance (<ulink

url="http://www.eia.org">http://www.eia.org</ulink>)</corpauthor>

	<corpauthor>Consumer Electronics Association (<ulink

url="http://www.ce.org">http://www.ce.org</ulink>)</corpauthor>

      </authorgroup>

      <title>EIA 608-B "Recommended Practice for Line 21 Data

Service"</title>

      <title>CEA-608-E R-2014 "Line 21 Data Services"</title>

    </biblioentry>



    <biblioentry id="en300294">

Documentation/DocBook/media/v4l/dev-sliced-vbi.xml

+1 −1
Original line number Diff line number Diff line
@@ -254,7 +254,7 @@ ETS&nbsp;300&nbsp;231, lsb first transmitted.</entry> 
	  <row>

	    <entry><constant>V4L2_SLICED_CAPTION_525</constant></entry>

	    <entry>0x1000</entry>

	    <entry><xref linkend="eia608" /></entry>

	    <entry><xref linkend="cea608" /></entry>

	    <entry>NTSC line 21, 284 (second field 21)</entry>

	    <entry>Two bytes in transmission order, including parity

bit, lsb first transmitted.</entry>

Documentation/DocBook/media/v4l/vidioc-g-sliced-vbi-cap.xml

+1 −1
Original line number Diff line number Diff line
@@ -205,7 +205,7 @@ ETS&nbsp;300&nbsp;231, lsb first transmitted.</entry> 
	  <row>

	    <entry><constant>V4L2_SLICED_CAPTION_525</constant></entry>

	    <entry>0x1000</entry>

	    <entry><xref linkend="eia608" /></entry>

	    <entry><xref linkend="cea608" /></entry>

	    <entry>NTSC line 21, 284 (second field 21)</entry>

	    <entry>Two bytes in transmission order, including parity

bit, lsb first transmitted.</entry>