Message ID | c45286f1-ca8f-80b1-385a-9ecba9d27a36@redhat.com |
---|---|
State | New |
Headers | show |
Series | manual: Adjust twalk_r documentation. | expand |
* Carlos O'Donell: > diff --git a/manual/search.texi b/manual/search.texi > index 979732f027..60c851229c 100644 > --- a/manual/search.texi > +++ b/manual/search.texi > @@ -630,8 +630,8 @@ see the @code{twalk_r} function below. > For each node in the tree with a node pointed to by @var{root}, the > @code{twalk_r} function calls the function provided by the parameter > @var{action}. For leaf nodes the function is called exactly once with > -@var{value} set to @code{leaf}. For internal nodes the function is > -called three times, setting the @var{value} parameter or @var{action} to > +@var{which} set to @code{leaf}. For internal nodes the function is > +called three times, setting the @var{which} parameter of @var{action} to > the appropriate value. The @var{closure} parameter is passed down to > each call of the @var{action} function, unmodified. Looks good to me. Thanks for fixing this. Florian
On 5/14/19 3:49 PM, Florian Weimer wrote: > * Carlos O'Donell: > >> diff --git a/manual/search.texi b/manual/search.texi >> index 979732f027..60c851229c 100644 >> --- a/manual/search.texi >> +++ b/manual/search.texi >> @@ -630,8 +630,8 @@ see the @code{twalk_r} function below. >> For each node in the tree with a node pointed to by @var{root}, the >> @code{twalk_r} function calls the function provided by the parameter >> @var{action}. For leaf nodes the function is called exactly once with >> -@var{value} set to @code{leaf}. For internal nodes the function is >> -called three times, setting the @var{value} parameter or @var{action} to >> +@var{which} set to @code{leaf}. For internal nodes the function is >> +called three times, setting the @var{which} parameter of @var{action} to >> the appropriate value. The @var{closure} parameter is passed down to >> each call of the @var{action} function, unmodified. > > Looks good to me. Thanks for fixing this. I pinged you on IRC to get your Reviewed-by:, thanks for that. Pushed.
diff --git a/ChangeLog b/ChangeLog index 7f2ed939a7..edfb9ad96b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2019-05-14 Carlos O'Donell <carlos@redhat.com> + + * manual/search.texi (Tree Search Function): Adjust twalk_r + documentation. + 2019-05-14 Adhemerval Zanella <adhemerval.zanella@linaro.org> [BZ #24544] diff --git a/manual/search.texi b/manual/search.texi index 979732f027..60c851229c 100644 --- a/manual/search.texi +++ b/manual/search.texi @@ -630,8 +630,8 @@ see the @code{twalk_r} function below. For each node in the tree with a node pointed to by @var{root}, the @code{twalk_r} function calls the function provided by the parameter @var{action}. For leaf nodes the function is called exactly once with -@var{value} set to @code{leaf}. For internal nodes the function is -called three times, setting the @var{value} parameter or @var{action} to +@var{which} set to @code{leaf}. For internal nodes the function is +called three times, setting the @var{which} parameter of @var{action} to the appropriate value. The @var{closure} parameter is passed down to each call of the @var{action} function, unmodified.
Florian, While reviewing twalk_r for a response to your other thread I foudn that I'd missed some typos in the manual. They stem from the use of 'which' in the manual, but 'value' in the headers. 8< --- 8< --- 8< From 5f2cf01ced480022be7fc1deaad6582cd7e3cc94 Mon Sep 17 00:00:00 2001 From: Carlos O'Donell <carlos@redhat.com> Date: Tue, 14 May 2019 15:33:02 -0400 Subject: [PATCH] manual: Adjust twalk_r documentation. --- ChangeLog | 5 +++++ manual/search.texi | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-)