All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 00/10] Add style guide
@ 2017-07-28  9:53 Akira Yokosawa
  2017-07-28  9:55 ` [PATCH 01/10] appendix: " Akira Yokosawa
                   ` (10 more replies)
  0 siblings, 11 replies; 40+ messages in thread
From: Akira Yokosawa @ 2017-07-28  9:53 UTC (permalink / raw)
  To: Paul E. McKenney; +Cc: perfbook, Akira Yokosawa

From cdfca8b81a7d4ee194272359d1775c0c343e0fbe Mon Sep 17 00:00:00 2001
From: Akira Yokosawa <akiyks@gmail.com>
Date: Fri, 28 Jul 2017 18:06:01 +0900
Subject: [PATCH 00/10] Add style guide

Hi Paul,

This patch series is my attempt to add a style guide for perfbook
in response to your suggestion.

I added it under appendix/styleguide.

It consists of three parts.

  1) Paul's conventions
  2) NIST style guide
  3) LaTeX conventions

I called several conventions as "LaTeX conventions", but they are not
restricted to LaTeX community.

In 3), I attempted a few experiments with the "floatrow" package.
As it conflicts with two-column layout, I need to localize its .sty
file and apply a workaround.

Experiments I did in 3) includes:

  a) Use "listings" environment for code snippets.
  b) Place captions of Tables and Listings at the top.
  c) Improve table layout.

They would involve quite a lot of modifications if we actually employ
the styles. My intention is to show the direction of possible
contributions. I'm not that sure such changes would be worthwhile, though. 

Also, there should be a lot of room to improve in English composition.
Hopefully, unnatural sentences are at least understandable.

Any feedback is welcome.

Note:
  The version of "verbatimbox" required for this series specified in
  patch #2 is newer than the one provided in TeX Live on Ubuntu 12.04 LTS,
  which reached its regular EOL this April. The one on Ubuntu 14.04 LTS
  should suffice. 

       Thanks, Akira.
--
Akira Yokosawa (10):
  appendix: Add style guide
  Specify required revision of 'verbatimbox'
  Localize floatrow.sty
  Apply workaround to floatrow.sty and rename it floatrowpf.sty
  Define 'listing' environment for style guide
  styleguide: Add listing environment examples
  Disable 'floatrow' layout in manually aligned code snippets
  styleguide: Add example of grouping code snippets
  styleguide: Add example of preferred table layout using 'booktabs'
  styleguide: Tweak layout of 'Limitation' table

 appendix/appendix.tex                     |    1 +
 appendix/styleguide/hello.c               |    9 +
 appendix/styleguide/samplecodesnippet.tex |   19 +
 appendix/styleguide/styleguide.tex        |  841 ++++++++++++++++
 defer/rcuusage.tex                        |    6 +-
 floatrowpf.sty                            | 1480 +++++++++++++++++++++++++++++
 howto/howto.tex                           |    4 +-
 perfbook.tex                              |    6 +-
 8 files changed, 2360 insertions(+), 6 deletions(-)
 create mode 100644 appendix/styleguide/hello.c
 create mode 100644 appendix/styleguide/samplecodesnippet.tex
 create mode 100644 appendix/styleguide/styleguide.tex
 create mode 100644 floatrowpf.sty

-- 
2.7.4


^ permalink raw reply	[flat|nested] 40+ messages in thread

end of thread, other threads:[~2017-08-05 15:50 UTC | newest]

Thread overview: 40+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-07-28  9:53 [PATCH 00/10] Add style guide Akira Yokosawa
2017-07-28  9:55 ` [PATCH 01/10] appendix: " Akira Yokosawa
2017-07-28  9:57 ` [PATCH 02/10] Specify required revision of 'verbatimbox' Akira Yokosawa
2017-07-28  9:58 ` [PATCH 03/10] Localize floatrow.sty Akira Yokosawa
2017-07-31  3:26   ` Paul E. McKenney
2017-07-31  4:05     ` Akira Yokosawa
2017-07-31  5:01       ` Akira Yokosawa
2017-07-31 12:45         ` Paul E. McKenney
2017-07-28 10:00 ` [PATCH 04/10] Apply workaround to floatrow.sty and rename it floatrowpf.sty Akira Yokosawa
2017-07-28 10:01 ` [PATCH 05/10] Define 'listing' environment for style guide Akira Yokosawa
2017-07-28 10:02 ` [PATCH 06/10] styleguide: Add listing environment examples Akira Yokosawa
2017-07-28 10:03 ` [PATCH 07/10] Disable 'floatrow' layout in manually aligned code snippets Akira Yokosawa
2017-07-28 10:04 ` [PATCH 08/10] styleguide: Add example of grouping " Akira Yokosawa
2017-07-28 10:05 ` [PATCH 09/10] styleguide: Add example of preferred table layout using 'booktabs' Akira Yokosawa
2017-07-28 10:06 ` [PATCH 10/10] styleguide: Tweak layout of 'Limitation' table Akira Yokosawa
2017-07-31 14:43 ` [PATCH v2 0/8] Add style guide Akira Yokosawa
2017-07-31 14:44   ` [PATCH v2 1/8] Localize floatrow.sty as floatrowpf.sty Akira Yokosawa
2017-07-31 14:46   ` [PATCH v2 2/8] Apply workaround to floatrowpf.sty Akira Yokosawa
2017-07-31 14:47   ` [PATCH v2 3/8] Define 'listing' environment for style guide Akira Yokosawa
2017-07-31 14:49   ` [PATCH v2 4/8] styleguide: Add listing environment examples Akira Yokosawa
2017-07-31 14:50   ` [PATCH v2 5/8] Disable 'floatrow' layout in manually aligned code snippets Akira Yokosawa
2017-07-31 14:51   ` [PATCH v2 6/8] styleguide: Add example of grouping " Akira Yokosawa
2017-07-31 14:52   ` [PATCH v2 7/8] styleguide: Add example of preferred table layout using 'booktabs' Akira Yokosawa
2017-07-31 14:52   ` [PATCH v2 8/8] styleguide: Tweak layout of 'Limitation' table Akira Yokosawa
2017-07-31 15:24   ` [PATCH v2 0/8] Add style guide Akira Yokosawa
2017-07-31 15:55     ` Paul E. McKenney
2017-07-31 15:57   ` Paul E. McKenney
2017-08-01 20:40   ` Paul E. McKenney
2017-08-02 14:57     ` Akira Yokosawa
2017-08-02 16:29       ` Paul E. McKenney
2017-08-02 22:22         ` Akira Yokosawa
2017-08-02 22:48           ` Paul E. McKenney
2017-08-05  2:09             ` Akira Yokosawa
2017-08-05  3:41               ` [PATCH 0/3] Employ auto-numbering in litmus tests Akira Yokosawa
2017-08-05  3:43                 ` [PATCH 1/3] Revert commits after "Localize floatrow.sty as floatrowpf.sty" Akira Yokosawa
2017-08-05  3:44                 ` [PATCH 2/3] advsync: Employ auto-numbering in litmus tests Akira Yokosawa
2017-08-05  3:46                 ` [PATCH 3/3] styleguide: Remove references to 'floatrow' and adjust context Akira Yokosawa
2017-08-05 15:09                 ` [PATCH 0/3] Employ auto-numbering in litmus tests Paul E. McKenney
2017-08-05 15:35                   ` Akira Yokosawa
2017-08-05 15:50                     ` Paul E. McKenney

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.