All of lore.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <randy.dunlap@oracle.com>
To: Daniel Walker <dwalker@fifo99.com>
Cc: Alan Stern <stern@rowland.harvard.edu>,
	Yinghai Lu <yinghai@kernel.org>,
	mingo@redhat.com, hpa@zytor.com, linux-kernel@vger.kernel.org,
	ebiederm@xmission.com, akpm@linux-foundation.org, gregkh@suse.de,
	tglx@linutronix.de, sarah.a.sharp@intel.com, mingo@elte.hu,
	linux-tip-commits@vger.kernel.org
Subject: Re: [tip:x86/doc] x86/doc: mini-howto for using earlyprintk=dbgp
Date: Thu, 05 Mar 2009 15:19:24 -0800	[thread overview]
Message-ID: <49B05DFC.1090807@oracle.com> (raw)
In-Reply-To: <1236294733.5937.92.camel@desktop>

Daniel Walker wrote:
> On Thu, 2009-03-05 at 15:05 -0800, Randy Dunlap wrote:
>> Daniel Walker wrote:
>>> On Thu, 2009-03-05 at 17:54 -0500, Alan Stern wrote:
>>>> On Thu, 5 Mar 2009, Daniel Walker wrote:
>>>>
>>>>> Fix up some typos, and make the requirements section slightly cleaner.
>>>>>
>>>>> Signed-Off-By: Daniel Walker dwalker@fifo99.com
>>>>>
>>>>> diff --git a/Documentation/x86/earlyprintk.txt b/Documentation/x86/earlyprintk.txt
>>>>> index 607b1a0..5b51aef 100644
>>>>> --- a/Documentation/x86/earlyprintk.txt
>>>>> +++ b/Documentation/x86/earlyprintk.txt
>>>>> @@ -9,7 +9,9 @@ and two USB cables, connected like this:
>>>>>  
>>>>>  1. There are three specific hardware requirements:
>>>>>  
>>>>> - a.) Host/target system needs to have USB debug port capability.
>>>>> + a.) You will need two USB ports. One on the client/console system and one one the target system.
>>>> s/one one/one on/
>>> Check.
>>>
>>>> You might also try harder to observe the 80-column rule.
>>> I wasn't aware it applied to documents ..
>> Yes, it does.
>>
> 
> Shall we add that to a document style guide? There's several other docs
> that don't conform to that..

Do we have a document style guide?  The comments in Documentation/CodingStyle
apply to documentation text files also, AFAIK.  Maybe that needs to be
stated explicitly.

As for other docs that don't conform:  we typically don't go around just
fixing 80-column rule infractions, but when a file is being modified anyway,
we prefer that other parts of it also be updated.

Thanks,
-- 
~Randy

  reply	other threads:[~2009-03-05 23:19 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20090303235354.GA7145@gamba.jf.intel.com>
2009-03-04  1:31 ` EHCI debug documentation Yinghai Lu
2009-03-04  1:36   ` Randy Dunlap
2009-03-04 17:57     ` Ingo Molnar
2009-03-04 21:25       ` Greg KH
2009-03-04 21:39         ` Eric W. Biederman
2009-03-04 21:59           ` Alan Stern
2009-03-04 22:55             ` Sarah Sharp
2009-03-05  0:11               ` [PATCH] x86/doc: doc the using earlyprintk=dbgp Yinghai Lu
2009-03-05 10:00                 ` [tip:x86/doc] x86/doc: mini-howto for " Yinghai Lu
2009-03-05 15:36                   ` Daniel Walker
2009-03-05 19:22                     ` Yinghai Lu
2009-03-05 22:40                       ` Daniel Walker
2009-03-05 22:54                         ` Alan Stern
2009-03-05 23:02                           ` Daniel Walker
2009-03-05 23:05                             ` Randy Dunlap
2009-03-05 23:12                               ` Daniel Walker
2009-03-05 23:19                                 ` Randy Dunlap [this message]
2009-03-05 23:32                                   ` Daniel Walker
2009-03-05 23:41                                     ` Randy Dunlap
2009-03-05 23:44                                       ` Daniel Walker
2009-03-06 14:57                                         ` Alan Stern
2009-03-06 15:03                                           ` Daniel Walker
2009-03-06 15:55                                             ` Alan Stern
2009-03-05 23:48                           ` Daniel Walker
2009-03-05 23:59                             ` Randy Dunlap
2009-03-06  0:09                               ` Daniel Walker
2009-03-06 15:52                                 ` Alan Stern
2009-03-06 15:55                                   ` Ingo Molnar
2009-03-06 16:16                                     ` Daniel Walker
2009-03-06  2:23                               ` Daniel Walker
2009-03-05  2:06             ` EHCI debug documentation Greg KH
2009-03-04 22:50   ` Sarah Sharp

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=49B05DFC.1090807@oracle.com \
    --to=randy.dunlap@oracle.com \
    --cc=akpm@linux-foundation.org \
    --cc=dwalker@fifo99.com \
    --cc=ebiederm@xmission.com \
    --cc=gregkh@suse.de \
    --cc=hpa@zytor.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-tip-commits@vger.kernel.org \
    --cc=mingo@elte.hu \
    --cc=mingo@redhat.com \
    --cc=sarah.a.sharp@intel.com \
    --cc=stern@rowland.harvard.edu \
    --cc=tglx@linutronix.de \
    --cc=yinghai@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.