Skip to contentSkip to conversation

scripts: allow docproc invocation from external

PATCH In review Jiri Slaby 3 participants 4 messages May 31, 2009 – Jun 5, 2009 Kbuild

lore
Share & tools
lore

Jiri Slaby

author
#0 lore raw

PATCH 1/1 scripts: allow docproc invocation from external

- getcwd returns path without a slash at the end, add the slash
- 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

[v2]
- use KBUILD_SRC instead of a newly introduced environment variable

Cc Sam Ravnborg <[email protected]>
Cc Randy Dunlap <[email protected]>
---
 scripts/basic/docproc.c |   13 +++++++++----
 1 files changed, 9 insertions(+), 4 deletions(-)
scripts/basic/docproc.c +9 -4
index 35bdc68..4c9523e 100644
@@ -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");
+	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);
Signature · 1 line
1.6.3
#1 lore raw
Quoted 1 line · Jiri Slaby

- getcwd returns path without a slash at the end, add the slash

Hi Jiri,

This part (above) fixes a bug, right?

Quoted 3 lines

- 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)

Quoted 24 lines

[v2]
- use KBUILD_SRC instead of a newly introduced environment variable

Cc Sam Ravnborg <[email protected]>
Cc Randy Dunlap <[email protected]>
---
 scripts/basic/docproc.c |   13 +++++++++----
 1 files changed, 9 insertions(+), 4 deletions(-)
scripts/basic/docproc.c +1 -1
index 35bdc68..4c9523e 100644
@@ -69,7 +69,7 @@ FILELINE * docsection;
 #define NOFUNCTION    "-nofunction"
 #define NODOCSECTIONS "-no-doc-sections"
 
-char *srctree;
+static char *srctree, *kernsrctree;
 
 void usage (void)
 {

scripts/basic/docproc.c void usage (void) · line 80

Quoted 5 lines
scripts/basic/docproc.c +1 -1
@@ -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?

Quoted 24 lines
scripts/basic/docproc.c +4 -2
+	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);

scripts/basic/docproc.c int main(int argc, char *argv[]) · line 392

Quoted 9 lines
scripts/basic/docproc.c +3 -0
@@ -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.

Signature · 3 lines
~Randy
LPC 2009, Sept. 23-25, Portland, Oregon
http://linuxplumbersconf.org/2009/
author
#2 lore raw
Quoted 6 lines · Randy Dunlap
Quoted 1 line · Jiri Slaby

- getcwd returns path without a slash at the end, add the slash

Hi Jiri,

This part (above) fixes a bug, right?

Yes, but the bug is not triggered when building from a kernel tree.

Quoted 6 lines
Quoted 3 lines

- 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)

Sure, I have out-of-kernel drivers (which I plan to merge, but keep out-of-tree development anyway) and have this in a makefile:
%.xml: %.tmpl

        KBUILD_SRC=$(KSRC) $(KDIR)/scripts/basic/docproc doc $^ > $@

so that I can build documentation from a .tmpl file for those drivers. SRCTREE defaults to cwd, so it finds sources referenced from the .tmpl file in current location. What didn't work is execution of scripts/kernel-doc. This is now executed with KBUILD_SRC prepended, which is what it should be.

#3 lore raw
In reply to Randy Dunlap
Quoted 5 lines · Randy Dunlap
Quoted 1 line · Jiri Slaby

- getcwd returns path without a slash at the end, add the slash

Hi Jiri,

Quoted 8 lines

This part (above) fixes a bug, right?

Quoted 3 lines

- 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)

Randy - it took this as an "Acked-by" and applied the patch with that. Please let me know if this is not ok.

Sam