All of lore.kernel.org
 help / color / mirror / Atom feed
From: greg@kroah.com (Greg KH)
To: kernelnewbies@lists.kernelnewbies.org
Subject: CHECK: Alignment should match open parenthesis
Date: Fri, 13 Mar 2015 15:46:17 +0100	[thread overview]
Message-ID: <20150313144617.GA19212@kroah.com> (raw)
In-Reply-To: <CAEnQRZBHun8i2Rbp7Fq1yWwckcAAxqtaUS5hQjzVfsz+Q1M75Q@mail.gmail.com>

On Fri, Mar 13, 2015 at 04:35:30PM +0200, Daniel Baluta wrote:
> On Fri, Mar 13, 2015 at 3:47 PM, Nicholas Mc Guire <der.herr@hofr.at> wrote:
> > On Fri, 13 Mar 2015, Nicholas Mc Guire wrote:
> >
> >> On Fri, 13 Mar 2015, palik imre wrote:
> >>
> >> > On Friday, 13 March 2015, 13:43, Nicholas Mc Guire <der.herr@hofr.at> wrote:
> >> > > On Fri, 13 Mar 2015, palik imre wrote:
> >> > >
> >> > >
> >> > > > Sorry for the silly question, but I have some issues with this checkpatch.pl warning.
> >> > > >
> >> > > > I mean Documentation/CodingStyle says:
> >> > > >
> >> > > > Outside of comments, documentation and except in Kconfig, spaces are never
> >> > > > used for indentation, and the above example is deliberately broken.
> >> > > >
> >> > > > But checkpatch.pl claims I should align to open parentheses.  These two things seem to be contradictory to me.  Could somebody clarify this?
> >> > >
> >> > > >
> >> > > leading tabs *followed* by spaces to align parameters to a function are fine
> >> >
> >> > The emacs settings in Documentation/CodingStyle seem to contradict to you,
> >> > as it is set up to use c-lineup-arglist-tabs-only
> >> >
> >> The problem is that CodingStyle does not explicitly address
> >> parameter alignment for functions that do not fit on a single line
> >> but checkpatch.pl does
> >>
> >> you can try it out - if you align to the opening braces with spaces
> >> with preceding TABs it will not fuss and this is also common practice.
> >>
> > here is a quick shot at summarizing this
> >
> >
> > If the parameter list to a functions would exceed the 80 char limit then break
> > it at the separators, and align to opening braces, e.g.:
> >
> >                         ret = fw_load_from_user_helper(fw, name, device,
> >                                                        opt_flags, timeout);
> >
> > or:
> >
> >         int =
> >         wait_for_completion_interruptible_timeout(data->completion,
> >                                                   PMI_TIMEOUT);
> >
> > Note that this is indented by tabs and then aligned with spaced to fit the
> > opening braces. If you can not fit it even if you break the parameter list
> > at the commas then indent by tabs only but *significantly* to the left of
> > the opening braces, e.g.:
> >
> >                 int ret = wait_for_completion_interruptible_timeout(
> >                                 &info->done, usecs_to_jiffies(TIMEOUT_US));
> >
> >
> > would be suprised if there is no writeup somewhere alredy
> > but I did not find this covered in Documentations anywhere.
> 
> I think it would be a coding idea to have this in CodingStyle doc :).

Really?  Do you want to codify every tiny thing here?  Just use common
sense people, it's not that big of a deal...

greg k-h

  reply	other threads:[~2015-03-13 14:46 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-13 12:07 CHECK: Alignment should match open parenthesis palik imre
2015-03-13 12:43 ` Nicholas Mc Guire
2015-03-13 13:09   ` palik imre
2015-03-13 13:28     ` Nicholas Mc Guire
2015-03-13 13:47       ` Nicholas Mc Guire
2015-03-13 14:35         ` Daniel Baluta
2015-03-13 14:46           ` Greg KH [this message]
2015-03-13 15:33           ` Nicholas Mc Guire
2015-03-13 16:15             ` Daniel Baluta
2015-03-13 16:46             ` Jeff Haran
2015-03-13 16:58               ` Nicholas Mc Guire
2015-03-13 17:18                 ` Jeff Haran
2015-03-13 17:31                   ` Nicholas Mc Guire
2015-03-13 18:05                     ` Jeff Haran
2015-03-13 18:57                       ` Nicholas Mc Guire

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=20150313144617.GA19212@kroah.com \
    --to=greg@kroah.com \
    --cc=kernelnewbies@lists.kernelnewbies.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.