Re: [PATCH V2 01/17] MdePkg/DebugLib.h: Add a new api DebugVPrint for DebugLib

[Jordan Justen <jordan.l.justen@intel.com>]

On 2019-03-17 17:14:40, Gao, Zhichao wrote:
> > -----Original Message-----
> > From: Justen, Jordan L
> > Sent: Friday, March 15, 2019 2:16 PM
> > 
> > On 2019-03-14 22:17:33, Zhichao Gao wrote:
> > > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1395
> > >
> > > Add a new api DebugVPrint prototype definition in the
> > > DebugLib header file. This api would expose a print
> > > routine with VaList parameter.
> > 
> > These lines seem to be fairly short, with the longest be 54 chars. I guess not a
> > problem, but by the recommendation says they could be up to 75 in length.
> > 
> > https://github.com/tianocore/tianocore.github.io/wiki/Commit-Message-
> > Format
> > 
> 
> It is hard for someone to control the characters in a line.

I guess that depends on your editor. :)

> Making the text massage readable base on the rules make more sense.
> It is easier to control the chars number within 75. Line length less
> than 76 characters is legal.

Yes, I mentioned it is legal, but it is noticably short. I don't think
it is so short that it is really a problem, so feel free to leave it
if you prefer.

> > 
> > According to the style guide:
> > 
> >   "Preferably, limit line lengths to 80 columns or less."
> > 
> > https://github.com/tianocore/tianocore.github.io/wiki/Code-Style-C
> > 
> > https://github.com/tianocore-
> > docs/Docs/raw/master/Specifications/CCS_2_1_Draft.pdf
> > 
> > But, this line uses 92 columns.
> > 
> > I think there are similar cases in other patches.
> 
> Right. This sentence I copied from the comment of DebugPrint
> function which might be designed for a long time. The CCS might not
> be designed as such style at that time. For this, it's better to
> change both of the two sentences.
> By the way, the whole edk2 repo may contain a lot of lines violated
> this rule. It takes effort to fix them all.

I agree there are many violations of this in edk2.

Usually, it's not too important to go around fixing the issues that
already happened, but if you are changing or adding some code, then
you can try to make sure the new lines you add are good.

-Jordan