aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-09-19 07:07:58 -0400
committerJonathan Corbet <corbet@lwn.net>2016-09-20 20:41:27 -0400
commit34fed7e7e0e56f885f309e8892a3571400072e37 (patch)
tree4ca5105f7e46a3ca8a72e18d17d46da0cd9d09eb
parent43fb67a5258c0f3d1d869cb7d72617d87b257c62 (diff)
Documentation/HOWTO: improve some markups to make it visually better
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 SubmittingPatches.rst and use **foo** instead of _foo_. - use bold for "The Perfect Patch" by removing a newline. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r--Documentation/HOWTO36
1 files changed, 16 insertions, 20 deletions
diff --git a/Documentation/HOWTO b/Documentation/HOWTO
index f297d5512885..784724aa4f34 100644
--- a/Documentation/HOWTO
+++ b/Documentation/HOWTO
@@ -292,11 +292,9 @@ process is as follows:
292It is worth mentioning what Andrew Morton wrote on the linux-kernel 292It is worth mentioning what Andrew Morton wrote on the linux-kernel
293mailing list about kernel releases: 293mailing list about kernel releases:
294 294
295:: 295 *"Nobody knows when a kernel will be released, because it's
296
297 "Nobody knows when a kernel will be released, because it's
298 released according to perceived bug status, not according to a 296 released according to perceived bug status, not according to a
299 preconceived timeline." 297 preconceived timeline."*
300 298
3014.x.y -stable kernel tree 2994.x.y -stable kernel tree
302------------------------- 300-------------------------
@@ -449,13 +447,14 @@ add your statements between the individual quoted sections instead of
449writing at the top of the mail. 447writing at the top of the mail.
450 448
451If you add patches to your mail, make sure they are plain readable text 449If you add patches to your mail, make sure they are plain readable text
452as stated in Documentation/SubmittingPatches. Kernel developers don't 450as stated in Documentation/SubmittingPatches.
453want to deal with attachments or compressed patches; they may want 451Kernel developers don't want to deal with
454to comment on individual lines of your patch, which works only that way. 452attachments or compressed patches; they may want to comment on
455Make sure you use a mail program that does not mangle spaces and tab 453individual lines of your patch, which works only that way. Make sure you
456characters. A good first test is to send the mail to yourself and try 454use a mail program that does not mangle spaces and tab characters. A
457to apply your own patch by yourself. If that doesn't work, get your 455good first test is to send the mail to yourself and try to apply your
458mail program fixed or change it until it works. 456own patch by yourself. If that doesn't work, get your mail program fixed
457or change it until it works.
459 458
460Above all, please remember to show respect to other subscribers. 459Above all, please remember to show respect to other subscribers.
461 460
@@ -496,8 +495,8 @@ Remember, being wrong is acceptable as long as you are willing to work
496toward a solution that is right. 495toward a solution that is right.
497 496
498It is normal that the answers to your first patch might simply be a list 497It is normal that the answers to your first patch might simply be a list
499of a dozen things you should correct. This does _not_ imply that your 498of a dozen things you should correct. This does **not** imply that your
500patch will not be accepted, and it is _not_ meant against you 499patch will not be accepted, and it is **not** meant against you
501personally. Simply correct all issues raised against your patch and 500personally. Simply correct all issues raised against your patch and
502resend it. 501resend it.
503 502
@@ -582,19 +581,17 @@ The reasons for breaking things up are the following:
582 581
583Here is an analogy from kernel developer Al Viro: 582Here is an analogy from kernel developer Al Viro:
584 583
585:: 584 *"Think of a teacher grading homework from a math student. The
586
587 "Think of a teacher grading homework from a math student. The
588 teacher does not want to see the student's trials and errors 585 teacher does not want to see the student's trials and errors
589 before they came up with the solution. They want to see the 586 before they came up with the solution. They want to see the
590 cleanest, most elegant answer. A good student knows this, and 587 cleanest, most elegant answer. A good student knows this, and
591 would never submit her intermediate work before the final 588 would never submit her intermediate work before the final
592 solution. 589 solution.*
593 590
594 The same is true of kernel development. The maintainers and 591 *The same is true of kernel development. The maintainers and
595 reviewers do not want to see the thought process behind the 592 reviewers do not want to see the thought process behind the
596 solution to the problem one is solving. They want to see a 593 solution to the problem one is solving. They want to see a
597 simple and elegant solution." 594 simple and elegant solution."*
598 595
599It may be challenging to keep the balance between presenting an elegant 596It may be challenging to keep the balance between presenting an elegant
600solution and working together with the community and discussing your 597solution and working together with the community and discussing your
@@ -632,7 +629,6 @@ For more details on what this should all look like, please see the
632ChangeLog section of the document: 629ChangeLog section of the document:
633 630
634 "The Perfect Patch" 631 "The Perfect Patch"
635
636 http://www.ozlabs.org/~akpm/stuff/tpp.txt 632 http://www.ozlabs.org/~akpm/stuff/tpp.txt
637 633
638 634