Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 11 Jan 2019 12:12:51 -0800
From:      Devin Teske <dteske@FreeBSD.org>
To:        rgrimes@FreeBSD.org
Cc:        Devin Teske <dteske@FreeBSD.org>, Warner Losh <imp@bsdimp.com>, Lars Engels <lme@FreeBSD.org>, src-committers <src-committers@FreeBSD.org>, svn-src-all@FreeBSD.org, svn-src-head@FreeBSD.org
Subject:   Re: svn commit: r342945 - in head: tools/build/mk usr.sbin/bluetooth usr.sbin/bluetooth/bluetooth-config
Message-ID:  <12293ACC-4C9C-4BFB-A04B-85D43AFA0837@FreeBSD.org>
In-Reply-To: <201901111916.x0BJGcLG022599@pdx.rh.CN85.dnsmgr.net>
References:  <201901111916.x0BJGcLG022599@pdx.rh.CN85.dnsmgr.net>

next in thread | previous in thread | raw e-mail | index | archive | help


> On Jan 11, 2019, at 11:16 AM, Rodney W. Grimes =
<freebsd@pdx.rh.CN85.dnsmgr.net> wrote:
>=20
>>> On Jan 11, 2019, at 10:36 AM, Rodney W. Grimes =
<freebsd@pdx.rh.CN85.dnsmgr.net> wrote:
>>>=20
>>>> On Fri, Jan 11, 2019 at 10:10 AM Rodney W. Grimes <
>>>> freebsd@pdx.rh.cn85.dnsmgr.net> wrote:
>>>>=20
>>>>>> On Fri, Jan 11, 2019 at 08:04:33AM -0800, Rodney W. Grimes wrote:
>>>>>>> The style of this .sh does not match the normal style of
>>>>>>> such things in base, especially with respect to long lines
>>>>>>> and indentation.
>>>>>>=20
>>>>>> Do we have a style guide for shell scripts in base? How should
>>>>>> indentation look like?
>>>>>=20
>>>>> Not that I can locate, but I can state that almost all
>>>>> of the base code uses tab indenting and limited to 80
>>>>> column widths, independent of c, sh, make, etc.
>>>>>=20
>>>>=20
>>>> We have a style.Makefile, style, style.mdoc and style.lua man =
pages. Maybe
>>>> it's time for style.sh, eh?
>>>=20
>>> Yes please!
>>>=20
>>=20
>> If we can agree to be professional and collegial, ...
>>=20
>> I'll start with chapters from the Style section of my book:
>> =
https://freebsdfrau.gitbooks.io/serious-shell-programming/content/style/aw=
k.html
>> =
<https://freebsdfrau.gitbooks.io/serious-shell-programming/content/style/a=
wk.html>
>=20
> If you can mdoc that and

Surely.


> take what applies to /bin/sh.
>=20

It *exclusively* applies to /bin/sh (as does my entire book).


> Might be easier to start with one of the other style.foo pages though.

I already did. Started with style(9), going back to mdoc would be easy.


> And we don't want to go to far and put all of our sh code
> out of conformance.

The Style entry in my book is based on my FreeBSD sh code.



>   For one variable being $foo or ${foo}
> is varied greatly, IMHO the rule should be that the file just
> be consistent through out, and that one or the other is the
> prefered style, but either is acceptable.
>=20

I talked about this at BSDCan in June. $foo is preferred (there
*is* a difference) and, as you say, if a file is consistently ${foo}
then it is fine.
--=20
Devin=



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?12293ACC-4C9C-4BFB-A04B-85D43AFA0837>