[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: *.m4 conventions
From: |
Bruno Haible |
Subject: |
Re: *.m4 conventions |
Date: |
Mon, 13 May 2024 22:23:13 +0200 |
Paul Eggert wrote:
> Although that's true for experts, it's not necessarily true for
> beginners who are the main audience for the first line. A beginner won't
> know whether stdio_h.m4 is for the entire stdio module, or just for
> configuring the stdio.h replacement, or just for configuring the stdio
> implementation, or something else.
>
> In general the first line could be quite helpful for a brief explanation
> of file contents, for non experts. Yes, this information can be put
> elsewhere in the .m4 file, but the first line is a better place for it.
I have nothing against adding these brief explanations as a second line:
# stdio_h.m4
# Autoconf macros for the stdio module.
# serial 42
or even in the first line:
# stdio_h.m4 - Autoconf macros for the stdio module.
# serial 42
This would satisfy my concerns as well as yours, I think?
Bruno
- [PATCH 0/4] New stdbit module, for C23 style stdbit.h, Paul Eggert, 2024/05/11
- [PATCH 1/4] stdbit: new module, Paul Eggert, 2024/05/11
- Re: [PATCH 1/4] stdbit: new module, Collin Funk, 2024/05/12
- Re: [PATCH 1/4] stdbit: new module, Paul Eggert, 2024/05/12
- Re: [PATCH 1/4] stdbit: new module, Collin Funk, 2024/05/12
- Re: [PATCH 1/4] stdbit: new module, Paul Eggert, 2024/05/12
- Re: Python class comments, Bruno Haible, 2024/05/13
- Re: Python class comments, Collin Funk, 2024/05/13
- Re: *.m4 conventions, Bruno Haible, 2024/05/13
- Re: *.m4 conventions, Paul Eggert, 2024/05/13
- Re: *.m4 conventions,
Bruno Haible <=
- Re: *.m4 conventions, Paul Eggert, 2024/05/13
[PATCH 3/4] stdbit: remove most module dependence, Paul Eggert, 2024/05/11
[PATCH 2/4] stdbit-tests: new module, Paul Eggert, 2024/05/11
[PATCH 4/4] stdbit: clean up namespace and simplify, Paul Eggert, 2024/05/11