[FFmpeg-devel] [PATCH] change AC3 to AC-3

Justin Ruggles justinruggles
Tue Aug 5 23:42:36 CEST 2008

Diego Biurrun wrote:
> On Sun, Aug 03, 2008 at 12:07:06PM -0400, Justin Ruggles wrote:
>> The Wanderer wrote:
>>> Justin Ruggles wrote:
>>>> Diego Biurrun wrote:
>>>>> On Sat, Aug 02, 2008 at 11:54:27PM -0400, Justin Ruggles wrote:
>>>>>> This is a cosmetic patch to change all "AC3" and "ac3" to "AC-3".
>>>>>> It also changes "E-AC3", "EAC3", etc... to "E-AC-3".
>>>>> I wonder why you did not commit this directly?  You are the
>>>>> maintainer of all those files.  All of this looks OK to me.  Since
>>>>> you posted a patch, you will now get a review ;)
>>>>>> --- libavcodec/aac_ac3_parser.c	(revision 14516)
>>>>>> +++ libavcodec/aac_ac3_parser.c	(working copy)
>>>>>> @@ -1,5 +1,5 @@
>>>>>>  /*
>>>>>> - * Common AAC and AC3 parser
>>>>>> + * Common AAC and AC-3 parser
>>>>> Lowercase this while you're at it.
>>>>>> @@ -21,7 +21,7 @@
>>>>>>   * @file ac3tab.c
>>>>>> - * tables taken directly from AC3 spec.
>>>>>> + * tables taken directly from AC-3 spec.
>>>>> from the, capitalize
>>>>>> @@ -21,7 +21,7 @@
>>>>>>   * @file ac3enc.c
>>>>>> - * The simplest AC3 encoder.
>>>>>> + * The simplest AC-3 encoder.
>>>>> lowercase, drop period
>>>> I don't quite understand your logic here.  All of these are
>>>> incomplete sentences, but you're suggesting to make some lowercase
>>>> w/o a period and some uppercase w/ a period.
>>> The difference is that e.g. the "tables taken directly from" entry has a
>>> verb, "taken", whereas the others do not. As I understand the issue, the
>>> rule used hereabouts - which was put in place by Diego, but does not
>>> appear to be the subject of much objection - is that a sentence or
>>> fragment with a verb gets the capital and the period, but a fragment
>>> without a verb does not get either.
>> Well let me go on record as an objector then. :)
> What alternative do you suggest?

I'm not saying that this is what I always follow... but if I had to
choose a set of rules...

I think that a period should be used for either indicating the end of a
complete sentence or separating a Doxygen brief description from a
detailed description.  For capitalization, I think that the only
considerations should be normal English grammer: start of a sentence,
proper names, acronyms, etc...

If we do agree on a standard, I would be willing to modify the files
which I maintain.  Otherwise, I think it should not be subject to
review, similar to our lenience on coding style.


More information about the ffmpeg-devel mailing list