Re: [PATCH -perfbook v3] howto: make ref to git archive explicit

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, 27 Dec 2023 14:39:20 +0800, zhouzhouyi@xxxxxxxxx wrote:
> From: Zhouyi Zhou <zhouzhouyi@xxxxxxxxx>
> 
> Make "git archive" in answer to Quick Quiz 1.3 more explicit, so that reader can easily know where
> "git archive" is.
> 
> Signed-off-by: Zhouyi Zhou<zhouzhouyi@xxxxxxxxx>
> ---
> Hi Akira
> 
> This is version 3 of my patch "make ref to git archive explicit".
> 
> I fixed the problem of version 1 under your guidance.
> 
> The idea is originally proposed by our Chinese version editor Yunjing Li, but 
> she was too modest to be a patch author.

In that case, a Reported-by: or Suggested-by tag should work, that is
if Yunjing Li is OK with her reachable email address exposed.

> 
> I have forget to add "Signed-off-by" in version 2 of my patch, sorry for the inconvenience that I brought.
> 
> Thanks again
> 
> Zhouyi
> --
>  bib/syncrefs.bib | 8 ++++++++
>  howto/howto.tex  | 2 +-
>  2 files changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/bib/syncrefs.bib b/bib/syncrefs.bib
> index 6ee50e3b..63a7a8bc 100644
> --- a/bib/syncrefs.bib
> +++ b/bib/syncrefs.bib
> @@ -2025,3 +2025,11 @@ Parallel Server on UNIX",
>   Month="September",
>   Note="Linux Plumbers Conference \url{https://lpc.events/event/16/contributions/1226/}";,
>  }
> +
> +@unpublished{PaulmckPerfbookGit,
> + author="Paul E. McKenney",
> + title="Is Parallel Programming Hard, And, If So, What Can You Do About It? Git Archive",
> + year="2023",
> + note={\url{git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/perfbook.git}},
> + lastchecked="December 27, 2023",
> +}
> diff --git a/howto/howto.tex b/howto/howto.tex
> index 55270cba..e7cd5f3c 100644
> --- a/howto/howto.tex
> +++ b/howto/howto.tex
> @@ -226,7 +226,7 @@ Here are a few possible strategies:
>  	only a blank sheet of paper.
>  \item	If you find the Quick Quizzes distracting but impossible
>  	to ignore, you can always clone the \LaTeX{} source for
> -	this book from the git archive.
> +	this book from the git archive~\cite{PaulmckPerfbookGit}.

Alternatively, you can put a footnote instead. For example:

  See \cref{sec:howto:Whose Book Is This?} for instructions to do this.

should also suffice.

Generally speaking, citations are suitable when you want readers
to read the referenced document/code and the like.  In this case,
presenting just the URL of Git repo won't give readers sufficient
info.

QQz 1.3 belongs to Section 1.2, while the instructions are in
Section 1.5.  So putting a footnote as a (kind-of) "forward reference"
looks more reasonable to me.

Can you try this alternative in v4 ?

If you are OK with it, please use

  Suggested-by: Akira Yokosawa <akiyks@xxxxxxxxx>

    Thanks, Akira
    
>  	You can then run the command \co{make nq}, which will
>  	produce a \co{perfbook-nq.pdf}.
>  	This PDF contains unobtrusive boxed tags where the Quick Quizzes





[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Index of Archives]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux