Re: [PATCH 1/1] scripts: allow docproc invocation from external

[Randy Dunlap <randy.dunlap@oracle.com>]

Jiri Slaby wrote:
> - getcwd returns path without a slash at the end, add the slash

Hi Jiri,

This part (above) fixes a bug, right?

> - add KBUILD_SRC env support, so that we can specify path for
>   kernel (to know where scripts/kernel-doc resides) and SRCTREE
>   (for searching files referenced in .tmpl) separately

Can you explain your usage a bit more so that I can understand some
justification for this change?  (not that I'm objecting to it)


> [v2]
> - use KBUILD_SRC instead of a newly introduced environment variable
> 
> Signed-off-by: Jiri Slaby <jirislaby@gmail.com>
> Cc: Sam Ravnborg <sam@ravnborg.org>
> Cc: Randy Dunlap <randy.dunlap@oracle.com>
> ---
>  scripts/basic/docproc.c |   13 +++++++++----
>  1 files changed, 9 insertions(+), 4 deletions(-)
> 
> diff --git a/scripts/basic/docproc.c b/scripts/basic/docproc.c
> index 35bdc68..4c9523e 100644
> --- a/scripts/basic/docproc.c
> +++ b/scripts/basic/docproc.c
> @@ -69,7 +69,7 @@ FILELINE * docsection;
>  #define NOFUNCTION    "-nofunction"
>  #define NODOCSECTIONS "-no-doc-sections"
>  
> -char *srctree;
> +static char *srctree, *kernsrctree;
>  
>  void usage (void)
>  {
> @@ -77,7 +77,8 @@ void usage (void)
>  	fprintf(stderr, "Input is read from file.tmpl. Output is sent to stdout\n");
>  	fprintf(stderr, "doc: frontend when generating kernel documentation\n");
>  	fprintf(stderr, "depend: generate list of files referenced within file\n");
> -	fprintf(stderr, "Environment variable SRCTREE: absolute path to kernel source tree.\n");
> +	fprintf(stderr, "Environment variable SRCTREE: absolute path to sources.\n");

What "sources" other than the kernel source tree is SRCTREE used for?

> +	fprintf(stderr, "                     KBUILD_SRC: absolute path to kernel source tree.\n");
>  }
>  
>  /*
> @@ -96,8 +97,8 @@ void exec_kernel_doc(char **svec)
>  			exit(1);
>  		case  0:
>  			memset(real_filename, 0, sizeof(real_filename));
> -			strncat(real_filename, srctree, PATH_MAX);
> -			strncat(real_filename, KERNELDOCPATH KERNELDOC,
> +			strncat(real_filename, kernsrctree, PATH_MAX);
> +			strncat(real_filename, "/" KERNELDOCPATH KERNELDOC,
>  					PATH_MAX - strlen(real_filename));
>  			execvp(real_filename, svec);
>  			fprintf(stderr, "exec ");
> @@ -178,6 +179,7 @@ void find_export_symbols(char * filename)
>  		char real_filename[PATH_MAX + 1];
>  		memset(real_filename, 0, sizeof(real_filename));
>  		strncat(real_filename, srctree, PATH_MAX);
> +		strncat(real_filename, "/", PATH_MAX - strlen(real_filename));
>  		strncat(real_filename, filename,
>  				PATH_MAX - strlen(real_filename));
>  		sym = add_new_file(filename);
> @@ -382,6 +384,9 @@ int main(int argc, char *argv[])
>  	srctree = getenv("SRCTREE");
>  	if (!srctree)
>  		srctree = getcwd(NULL, 0);
> +	kernsrctree = getenv("KBUILD_SRC");
> +	if (!kernsrctree)
> +		kernsrctree = srctree;
>  	if (argc != 3) {
>  		usage();
>  		exit(1);


Thanks.
-- 
~Randy
LPC 2009, Sept. 23-25, Portland, Oregon
http://linuxplumbersconf.org/2009/