git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/2] check-headers: add header usage checks for .c files

From
David Aguilar <davvid@gmail.com>
Date
Sep 15, 2014, 19:49 UTC
Message-ID
<20140915194915.GA1740@gmail.com>
In-Reply-To
<xmqqfvfs66ad.fsf@gitster.dls.corp.google.com>
On Mon, Sep 15, 2014 at 12:19:06PM -0700, Junio C Hamano wrote:
Show 23 quoted lines
> Junio C Hamano <gitster@pobox.com> writes:
> 
> > David Aguilar <davvid@gmail.com> writes:
> >
> >> Teach check-header.sh to ensure that the first included header in .c
> >> files is either git-compat-util.h, builtin.h, or cache.h.
> >>
> >> Ensure that common-cmds.h is only included by help.c.
> >>
> >> Move the logic into functions so that we can skip parts of the check.
> >>
> >> Signed-off-by: David Aguilar <davvid@gmail.com>
> >> ---
> >> This depends on my previous patch that adds check-header.sh.
> >> ...
> >> +check_headers () {
> >> +	for header in *.h ewah/*.h vcs-svn/*.h xdiff/*.h
> >> +	do
> >> +		check_header "$header"
> >
> > Hmmmm, doesn't check_header run "$@" as a command?
> 
> Taking the previous two together, perhaps
Thanks, yes, that's better.
Show 38 quoted lines
>  check-headers.sh | 13 ++++++++-----
>  1 file changed, 8 insertions(+), 5 deletions(-)
> 
> diff --git a/check-headers.sh b/check-headers.sh
> index 7f25e7a..526381e 100755
> --- a/check-headers.sh
> +++ b/check-headers.sh
> @@ -20,6 +20,7 @@ maybe_exit () {
>  
>  check_header () {
>  	header="$1"
> +	shift
>  	case "$header" in
>  	common-cmds.h)
>  		# should only be included by help.c, not checked
> @@ -38,15 +39,17 @@ check_header () {
>  check_headers () {
>  	for header in *.h ewah/*.h vcs-svn/*.h xdiff/*.h
>  	do
> -		check_header "$header"
> +		check_header "$header" "$@"
>  	done
>  }
>  
>  check_header_usage () {
> -	first=$(grep '^#include' "$1" |
> -		head -n1 |
> -		sed -e 's,#include ",,' -e 's,"$,,')
> -
> +	first=$( 
> +		sed -n -e '/^#include/{
> +			s/#include ["<]\(.*\)".*/\1/p
> +			q
> +		}' "$1"
> +	)
>  	case "$first" in
>  	cache.h|builtin.h|git-compat-util.h)
>  		# happy
-- 
David
Previous: Junio C Hamano
Message 6 of 6 in “check-headers: add header usage checks for .c files”
  1. 1/2 check-headers: add header usage checks for .c filesDavid Aguilar, Sep 14, 2014
  2. 2/2 cleanups: ensure that git-compat-util.h is included firstDavid Aguilar, Sep 14, 2014
  3. Junio C HamanoSep 15, 2014
  4. Junio C HamanoSep 15, 2014
  5. Junio C HamanoSep 15, 2014
  6. David AguilarSep 15, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.