Monday, January 14, 2019

Re: [Discuss-gnuradio] [GREP] GNU Radio Coding Guidelines

I realize that I'm late to the game, but I was recently reminded of this
GREP (and it's associated GREP 0011). I'm all for cleaning the code, but
the current .clang-format rules create a problem (that's addressed in
GREP 0011).

Specifically, the current .clang-format would change the files so much,
that the repository history would become useless. In GREP 0011, this is
referred to as a "history reset".

I'd like to suggest a middle ground. A .clang-format can easily be
crafted that uses the old GNU Radio guidelines. This would provide
minimal changes to the files, and a "history reset" would be avoided (or
at least mitigated).

Comments, questions or concerns?

Ron

GREPs:

https://github.com/gnuradio/greps/blob/master/grep-0001-coding-guidelines.md

https://github.com/gnuradio/greps/blob/master/grep-0011-code-reformatting.md

Old guidelines:

https://wiki.gnuradio.org/index.php/Coding_guide_impl

https://wiki.gnuradio.org/index.php/BlocksCodingGuide

On 2/15/18 12:20, Martin Braun wrote:
> Hi all,
>
> recently, we announced the GREP process (see also here:
> https://www.gnuradio.org/blog/gnu-radio-enhancement-proposal-process/).
>
> The first actual GNU Radio Enhancement Proposal is about *coding
> guidelines*, you can find the associated PR here:
> https://github.com/gnuradio/greps/pull/4
>
> To recap the process, this PR will be up for discussion for a little
> longer until there's no objections to merging it. Merging it does not
> however finalize it, it just means it's deemed good enough to become an
> official GREP, in "Draft" status. Eventually, we'll flag it as "Active",
> and even then, it's open for discussion (but once that happens, it'll
> also become the official coding guidelines for the project!).
>
> If you're interested in the GREP process in general, in the coding
> guidelines specifically, or both, I would recommend checking out the
> repository, and commenting.
>
> The guidelines themselves are currently 100% up for debate. I copied
> them from another project and renamed the project name to "GNU Radio" as
> a place to get started.
>
> Cheers,
> Martin
>
> _______________________________________________
> Discuss-gnuradio mailing list
> Discuss-gnuradio@gnu.org
> https://lists.gnu.org/mailman/listinfo/discuss-gnuradio
>

_______________________________________________
Discuss-gnuradio mailing list
Discuss-gnuradio@gnu.org
https://lists.gnu.org/mailman/listinfo/discuss-gnuradio

No comments:

Post a Comment