Re: [PATCH v2 1/4] run-command: make `exists_in_PATH()` non-static
From: Đoàn Trần Công Danh <hidden>
Date: 2021-04-08 11:22:45
On 2021-04-07 19:33:30+0200, Miriam Rubio [off-list ref] wrote:
From: Pranit Bauva <redacted> Removes the `static` keyword from `exists_in_PATH()` function and declares the function in `run-command.h` file. The function will be used in bisect_visualize() in a later commit. `exists_in_PATH()` and `locate_in_PATH()` functions don't depend on file-local variables.
Isn't this implementation detail? I think we shouldn't include them in the commit message.
quoted hunk ↗ jump to hunk
Mentored by: Christian Couder [off-list ref] Mentored by: Johannes Schindelin [off-list ref] Signed-off-by: Tanushree Tumane <redacted> Signed-off-by: Miriam Rubio <redacted> --- run-command.c | 2 +- run-command.h | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-)diff --git a/run-command.c b/run-command.c index be6bc128cd..210b8858f7 100644 --- a/run-command.c +++ b/run-command.c@@ -211,7 +211,7 @@ static char *locate_in_PATH(const char *file) return NULL; } -static int exists_in_PATH(const char *file) +int exists_in_PATH(const char *file) { char *r = locate_in_PATH(file); int found = r != NULL;diff --git a/run-command.h b/run-command.h index d08414a92e..a520ad1342 100644 --- a/run-command.h +++ b/run-command.h@@ -179,6 +179,16 @@ void child_process_clear(struct child_process *); int is_executable(const char *name); +/** + * Returns if a $PATH given by parameter is found or not (it is NULL). This + * function uses locate_in_PATH() function that emulates the path search that + * execvp would perform. Memory used to store the resultant path is freed by + * the function.
I think this documentation focused too much in implementation detail, locate_in_PATH is still an internal linkage symbol at this stage. I think its mention here doesn't improve anything. Further more, "a $PATH given by parameter" is not what this function does, the function check if a given "file" is found in "$PATH" or not. I would copy 2 first paragraphs of locate_in_PATH's documentation, and append the documentation for return values instead: -- Danh