Re: [Outreachy] Wiki updated needed - Patchset Subject

[Alison Schofield <alison.schofield@intel.com>]

On Tue, Nov 01, 2022 at 10:31:53AM +0530, Deepak R Varma wrote:
> On Mon, Oct 31, 2022 at 06:39:23PM -0700, Alison Schofield wrote:
> > On Mon, Oct 31, 2022 at 10:33:10PM +0100, Julia Lawall wrote:
> > >
> > >
> > > On Tue, 1 Nov 2022, Deepak R Varma wrote:
> > >
> > > > On Fri, Oct 28, 2022 at 01:32:41PM -0700, Alison Schofield wrote:
> > > > > On Sat, Oct 29, 2022 at 12:29:39AM +0530, Deepak R Varma wrote:
> > > >
> > > > Hello Alison,
> > > > I have attempted to introduce a new section and supporting information to
> > > > accomplish guidelines on following driver style for patch work. Could you please
> > > > and suggest if any edits are required.
> > > >
> > > > New section: "Following the Driver commit style"
> > >
> > > reduces confusion/errors and easy on eyes. ->
> > > reduces confusion/errors and is easy on eyes.
> > >
> > > Use `git log <<file.c>>` command to review ->
> > > Use the `git log <<file.c>>` command to review
> > >
> > > patch log message -> the patch log message
> > >
> > > Later in the same sentence, I odn't know what you ean by credentials.
> > >
> > > Additionally, following git command provides ->
> > > Additionally, the following git command provides
> > >
> > > The output for:
> > >
> > > git log --pretty=oneline --abbrev-commit
> > >
> > > looks the same as
> > >
> > > git log --oneline
> > >
> > > The latter should already be suggested somewhere in the documentation.
> > > Maybe this place is better, and it should be removed from wher it was
> > > before?
> > >
> > > "Since this is one of the most frequently used git commands, you should
> > > add this command to your shell profile using the following bashrc alias:"
> > > "you should" seems excessive.  git log --oneline is pretty easy to type
> > > already.
> >
> > Deeva,
> > I picked this up "git log --pretty=oneline --abbrev-commit" from
> > Outreachy in 2016 and have been using it as my 'gitpretty' ever
> > since :)
> >
> > You'll find it in the section 'Exploring the kernel tree'.
> > Change that to be the simpler "git log --oneline"
> >
> > That's why we need fresh eyes to update the tutorial!!!
> >
> > >
> > > Use consistent patch prefix as available from the history ->
> > > Use a consistent patch prefix as available from the history
> > >
> >
> > I may have missed this...
> >
> > Use git log --oneline, in an 80 column view, to confirm the commit message
> > does not wrap the line.
> >
> > > small case -> lower case
> > >
> > > capitalized case -> upper case
> > >
> > > Put best effort to keep -> Try to keep
> > >
> > > The example of inconsistent commits is clearly not great, but one can end
> > > up with inconsistent commits when some patches cover only one file and
> > > some patches cover multiple files.
> > >
> > > julia
> 
> Thank you very much Julia and Alison for the review and feedback. I have updated
> the page accordingly and can be reviewed. Let me know if you have any further
> comments.

Thanks Deeva! I looked it over and it looks very thorough and useful.
Alison

> 
> > >
> >
> 
> 
>