Re: [PATCH 1/4] howto: Use '\cref' consistently

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

 



Hello SeongJae,

On Sun, 4 Apr 2021 09:50:07 +0200, SeongJae Park wrote:
> 'howto' chapter is using mix of '\cref' and 'Chapter~\ref'.  This commit
> makes it to consistently use the shorter one, '\cref'.
> 
> Signed-off-by: SeongJae Park <sj38.park@xxxxxxxxx>
> ---
>  howto/howto.tex | 38 +++++++++++++++++++-------------------
>  1 file changed, 19 insertions(+), 19 deletions(-)
> 
> diff --git a/howto/howto.tex b/howto/howto.tex
> index 7de1dbd9..4a00bb3c 100644
> --- a/howto/howto.tex
> +++ b/howto/howto.tex
> @@ -56,22 +56,22 @@ that it has brought to us!
>  This book is a handbook of widely applicable and heavily
>  used design techniques, rather than
>  a collection of optimal algorithms with tiny areas of applicability.
> -You are currently reading Chapter~\ref{chp:How To Use This Book}, but
> +You are currently reading \cref{chp:How To Use This Book}, but
>  you knew that already.
> -Chapter~\ref{chp:Introduction} gives a high-level overview of parallel
> +\cref{chp:Introduction} gives a high-level overview of parallel

Please use \Cref{} at the beginning of a sentence.

This does not matter at the moment, but in the long run,
once we finish the conversion to \cref{}/\Cref{}s,
cleveref will allow us to choose other convention of

    Figure 1 ..., Fig. 2 ...

,or

    Figure 1 ..., fig. 2 ...

to save some paper/display area.

Excerpt of cleveref's user manual:

    If you just want to get going quickly with cleveref, and
    come back later to read up on all the features it provides
    in more detail, here’s what you need to do. Wherever you
    would previously have used \ref, use \cref instead.
    (Except at the beginning of a sentence, where you should
    use \Cref.)

>  programming.
>  
> -Chapter~\ref{chp:Hardware and its Habits} introduces shared-memory
> +\cref{chp:Hardware and its Habits} introduces shared-memory

Ditto.  And there are same patterns below.

Can you fix them and resend the series?

       Thanks, Akira

>  parallel hardware.
>  After all, it is difficult to write good parallel code unless you
>  understand the underlying hardware.
>  Because hardware constantly evolves, this chapter will always be
>  out of date.
>  We will nevertheless do our best to keep up.
> -Chapter~\ref{chp:Tools of the Trade} then provides a very brief overview
> +\cref{chp:Tools of the Trade} then provides a very brief overview
>  of common shared-memory parallel-programming primitives.
>  
> -Chapter~\ref{chp:Counting} takes an in-depth look at parallelizing
> +\cref{chp:Counting} takes an in-depth look at parallelizing
>  one of the simplest problems imaginable, namely counting.
>  Because almost everyone has an excellent grasp of counting, this chapter
>  is able to delve into many important parallel-programming issues without
> @@ -79,9 +79,9 @@ the distractions of more-typical computer-science problems.
>  My impression is that this chapter has seen the greatest use in
>  parallel-programming coursework.
>  
> -Chapter~\ref{cha:Partitioning and Synchronization Design}
> +\cref{cha:Partitioning and Synchronization Design}
>  introduces a number of design-level methods of addressing the issues
> -identified in Chapter~\ref{chp:Counting}.
> +identified in \cref{chp:Counting}.
>  It turns out that it is important to address parallelism at
>  the design level when feasible:
>  To paraphrase \pplsur{Edsger W.}{Dijkstra}~\cite{Dijkstra:1968:LEG:362929.362947},
> @@ -90,40 +90,40 @@ suboptimal''~\cite{PaulEMcKenney2012HOTPARsuboptimal}.
>  
>  The next three chapters examine three important approaches to
>  synchronization.
> -Chapter~\ref{chp:Locking} covers locking, which is still not only the
> +\cref{chp:Locking} covers locking, which is still not only the
>  workhorse of production-quality parallel programming, but is also widely
>  considered to be parallel programming's worst villain.
> -Chapter~\ref{chp:Data Ownership} gives a brief overview of data ownership,
> +\cref{chp:Data Ownership} gives a brief overview of data ownership,
>  an often overlooked but remarkably pervasive and powerful approach.
> -Finally, Chapter~\ref{chp:Deferred Processing} introduces a number of
> +Finally, \cref{chp:Deferred Processing} introduces a number of
>  deferred-processing mechanisms, including reference counting,
>  hazard pointers, sequence locking, and RCU\@.
>  
> -Chapter~\ref{chp:Data Structures} applies the lessons of previous
> +\cref{chp:Data Structures} applies the lessons of previous
>  chapters to hash tables, which are heavily used due
>  to their excellent partitionability, which (usually) leads to excellent
>  performance and scalability.
>  
>  As many have learned to their sorrow, parallel programming without
>  validation is a sure path to abject failure.
> -Chapter~\ref{chp:Validation} covers various forms of testing.
> +\cref{chp:Validation} covers various forms of testing.
>  It is of course impossible to test reliability into your program
> -after the fact, so Chapter~\ref{chp:Formal Verification}
> +after the fact, so \cref{chp:Formal Verification}
>  follows up with a brief overview of a couple of practical approaches to
>  formal verification.
>  
> -Chapter~\ref{chp:Putting It All Together}
> +\cref{chp:Putting It All Together}
>  contains a series of moderate-sized parallel programming problems.
>  The difficulty of these problems vary, but should be appropriate for
>  someone who has mastered the material in the previous chapters.
>  
> -Chapter~\ref{sec:advsync:Advanced Synchronization}
> +\cref{sec:advsync:Advanced Synchronization}
>  looks at advanced synchronization methods, including
>  non-blocking synchronization and parallel real-time computing,
> -while Chapter~\ref{chp:Advanced Synchronization: Memory Ordering}
> +while \cref{chp:Advanced Synchronization: Memory Ordering}
>  covers the advanced topic of memory ordering.
> -Chapter~\ref{chp:Ease of Use} follows up with some ease-of-use advice.
> -Chapter~\ref{chp:Conflicting Visions of the Future}
> +\cref{chp:Ease of Use} follows up with some ease-of-use advice.
> +\cref{chp:Conflicting Visions of the Future}
>  looks at a few possible future directions, including
>  shared-memory parallel system design, software and hardware transactional
>  memory, and functional programming for parallelism.
> @@ -552,6 +552,6 @@ The style for this particular book is documented in
>  
>  As noted at the beginning of this section, I am this book's editor.
>  However, if you choose to contribute, it will be your book as well.
> -In that spirit, I offer you Chapter~\ref{chp:Introduction}, our introduction.
> +In that spirit, I offer you \cref{chp:Introduction}, our introduction.
>  
>  \QuickQuizAnswersChp{qqzhowto}
> 





[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