diff mbox series

[v2,04/11] run-command: make `exists_in_PATH()` non-static

Message ID 20200128144026.53128-5-mirucam@gmail.com (mailing list archive)
State New, archived
Headers show
Series Finish converting git bisect to C part 1 | expand

Commit Message

Miriam R. Jan. 28, 2020, 2:40 p.m. UTC
From: Pranit Bauva <pranit.bauva@gmail.com>

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.

Mentored by: Christian Couder <chriscool@tuxfamily.org>
Mentored by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Signed-off-by: Tanushree Tumane <tanushreetumane@gmail.com>
Signed-off-by: Miriam Rubio <mirucam@gmail.com>
---
 run-command.c |  2 +-
 run-command.h | 11 +++++++++++
 2 files changed, 12 insertions(+), 1 deletion(-)

Comments

Johannes Schindelin Jan. 30, 2020, 12:36 p.m. UTC | #1
Hi Miriam,

On Tue, 28 Jan 2020, Miriam Rubio wrote:

> From: Pranit Bauva <pranit.bauva@gmail.com>
>
> 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.

I inspected the code in `exists_in_PATH()` and in `locate_in_PATH()` and
it looks as if neither of them depended on file-local variables (which
would otherwise need to be addressed when exporting the function).

If you contribute another iteration of this patch series, it might make
sense to mention this in the commit message explicitly.

Thanks,
Dscho

>
> Mentored by: Christian Couder <chriscool@tuxfamily.org>
> Mentored by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
> Signed-off-by: Tanushree Tumane <tanushreetumane@gmail.com>
> Signed-off-by: Miriam Rubio <mirucam@gmail.com>
> ---
>  run-command.c |  2 +-
>  run-command.h | 11 +++++++++++
>  2 files changed, 12 insertions(+), 1 deletion(-)
>
> diff --git a/run-command.c b/run-command.c
> index f5e1149f9b..4df975178d 100644
> --- a/run-command.c
> +++ b/run-command.c
> @@ -210,7 +210,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 592d9dc035..7c8e206d97 100644
> --- a/run-command.h
> +++ b/run-command.h
> @@ -172,6 +172,17 @@ 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.
> + *
> + * The caller should ensure that $PATH contains no directory
> + * separators.
> + */
> +int exists_in_PATH(const char *);
> +
>  /**
>   * Start a sub-process. Takes a pointer to a `struct child_process`
>   * that specifies the details and returns pipe FDs (if requested).
> --
> 2.21.1 (Apple Git-122.3)
>
>
Miriam R. Jan. 30, 2020, 2:41 p.m. UTC | #2
Hi,

El jue., 30 ene. 2020 a las 13:36, Johannes Schindelin
(<Johannes.Schindelin@gmx.de>) escribió:
>
> Hi Miriam,
>
> On Tue, 28 Jan 2020, Miriam Rubio wrote:
>
> > From: Pranit Bauva <pranit.bauva@gmail.com>
> >
> > 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.
>
> I inspected the code in `exists_in_PATH()` and in `locate_in_PATH()` and
> it looks as if neither of them depended on file-local variables (which
> would otherwise need to be addressed when exporting the function).
>
> If you contribute another iteration of this patch series, it might make
> sense to mention this in the commit message explicitly.

Ok, I will add the comment in the commit message.
Thank you.

Best,
Miriam

>
> Thanks,
> Dscho
>
> >
> > Mentored by: Christian Couder <chriscool@tuxfamily.org>
> > Mentored by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
> > Signed-off-by: Tanushree Tumane <tanushreetumane@gmail.com>
> > Signed-off-by: Miriam Rubio <mirucam@gmail.com>
> > ---
> >  run-command.c |  2 +-
> >  run-command.h | 11 +++++++++++
> >  2 files changed, 12 insertions(+), 1 deletion(-)
> >
> > diff --git a/run-command.c b/run-command.c
> > index f5e1149f9b..4df975178d 100644
> > --- a/run-command.c
> > +++ b/run-command.c
> > @@ -210,7 +210,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 592d9dc035..7c8e206d97 100644
> > --- a/run-command.h
> > +++ b/run-command.h
> > @@ -172,6 +172,17 @@ 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.
> > + *
> > + * The caller should ensure that $PATH contains no directory
> > + * separators.
> > + */
> > +int exists_in_PATH(const char *);
> > +
> >  /**
> >   * Start a sub-process. Takes a pointer to a `struct child_process`
> >   * that specifies the details and returns pipe FDs (if requested).
> > --
> > 2.21.1 (Apple Git-122.3)
> >
> >
diff mbox series

Patch

diff --git a/run-command.c b/run-command.c
index f5e1149f9b..4df975178d 100644
--- a/run-command.c
+++ b/run-command.c
@@ -210,7 +210,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 592d9dc035..7c8e206d97 100644
--- a/run-command.h
+++ b/run-command.h
@@ -172,6 +172,17 @@  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.
+ *
+ * The caller should ensure that $PATH contains no directory
+ * separators.
+ */
+int exists_in_PATH(const char *);
+
 /**
  * Start a sub-process. Takes a pointer to a `struct child_process`
  * that specifies the details and returns pipe FDs (if requested).