[pgpool-hackers: 3382] Re: [pgpool-committers: 6031] pgpool: Doc: run auto indent using emacs.

Tatsuo Ishii ishii at sraoss.co.jp
Fri Aug 16 08:05:39 JST 2019


I have applied auto indentation to all SGML documents from master to
3.6 stable branches that has SGML docs. The indentation rule is
exactly same as PostgreSQL 10 or before (PostgreSQL 11 or after use
XGML instead of SGML). I believe this makes developers' life a little
bit easier because they will be less troubled by the random
indentation when they try to back-port a doc change.

The tool used was emacs + psgml introduced in PostgreSQL 10 doc:
https://www.postgresql.org/docs/10/docguide-authoring.html#id-1.11.11.7.3

Actual elisp settings used is in the commit message below and the
small script I used is:

find . -name '*.sgml' -print|while read i
do
  echo "==== processing $i ====="
  emacs --script $HOME/bin/indent.el $i >> indent.log 2>&1
done

(I ran this on my Ubuntu 18 laptop, and emacs version was 25.2.1).

Memo to those who want to try this again in the future:

If you try commit something like:

git commit doc/src/sgml/*.sgml doc/src/sgml/ref/*.sgml

it will fail because bookindex.sgml is not in the git repository (it
is generated while processing SGML files). You need to remove the file
from the git commit argument. What I did was pretty simple:

Create file list using "ls doc/src/sgml/*.sgml doc/src/sgml/ref/*.sgml> file",
then edit "file" to remove bookindex.sgml. Finally,

git commit `cat file`

Probably there should be better way to do this though.

Best regards,
--
Tatsuo Ishii
SRA OSS, Inc. Japan
English: http://www.sraoss.co.jp/index_en.php
Japanese:http://www.sraoss.co.jp

From: Tatsuo Ishii <ishii at sraoss.co.jp>
Subject: [pgpool-committers: 6031] pgpool: Doc: run auto indent using emacs.
Date: Thu, 15 Aug 2019 22:44:14 +0000
Message-ID: <E1hyOTe-00031a-4e at gothos.postgresql.org>

> Doc: run auto indent using emacs.
> 
> Here is the emacs script F.Y.I.
> 
> ;; must be run by emacs
> (load "/home/t-ishii/.emacs.d/init.el")
> (find-file (nth 0 command-line-args-left));
> (indent-region (point-min) (point-max));
> (save-buffer)
> 
> Branch
> ------
> V3_6_STABLE
> 
> Details
> -------
> https://git.postgresql.org/gitweb?p=pgpool2.git;a=commitdiff;h=d023c51b4845e86a14bd6aeb2af3216d33089d94
> 
> Modified Files
> --------------
> doc.ja/src/sgml/advanced.sgml                      | 1974 ++---
> doc.ja/src/sgml/biblio.sgml                        |  596 +-
> doc.ja/src/sgml/client-auth.sgml                   |  740 +-
> doc.ja/src/sgml/config.sgml                        |  450 +-
> doc.ja/src/sgml/connection-pooling.sgml            | 2018 ++---
> doc.ja/src/sgml/connection-settings.sgml           | 3048 +++----
> doc.ja/src/sgml/errcodes-table.sgml                | 1012 +--
> doc.ja/src/sgml/examples.sgml                      | 4338 ++++-----
> doc.ja/src/sgml/failover.sgml                      | 1226 +--
> doc.ja/src/sgml/healthcheck.sgml                   |  526 +-
> doc.ja/src/sgml/history.sgml                       |   88 +-
> doc.ja/src/sgml/info.sgml                          |   50 +-
> doc.ja/src/sgml/installation-rpm.sgml              |  390 +-
> doc.ja/src/sgml/installation-tips.sgml             |  126 +-
> doc.ja/src/sgml/installation.sgml                  | 1132 +--
> doc.ja/src/sgml/intro.sgml                         |  406 +-
> doc.ja/src/sgml/loadbalance.sgml                   | 1848 ++--
> doc.ja/src/sgml/memcache.sgml                      | 1162 +--
> doc.ja/src/sgml/misc-config.sgml                   |  474 +-
> doc.ja/src/sgml/notation.sgml                      |   38 +-
> doc.ja/src/sgml/online-recovery.sgml               | 1026 +--
> doc.ja/src/sgml/pgpool.sgml                        |  104 +-
> doc.ja/src/sgml/problems.sgml                      |   10 +-
> doc.ja/src/sgml/ref/pcp_attach_node.sgml           |   76 +-
> doc.ja/src/sgml/ref/pcp_common_options.sgml        |  264 +-
> doc.ja/src/sgml/ref/pcp_detach_node.sgml           |  100 +-
> doc.ja/src/sgml/ref/pcp_node_count.sgml            |   52 +-
> doc.ja/src/sgml/ref/pcp_node_info.sgml             |  190 +-
> doc.ja/src/sgml/ref/pcp_pool_status.sgml           |   72 +-
> doc.ja/src/sgml/ref/pcp_proc_count.sgml            |   32 +-
> doc.ja/src/sgml/ref/pcp_proc_info.sgml             |  206 +-
> doc.ja/src/sgml/ref/pcp_promote_node.sgml          |  112 +-
> doc.ja/src/sgml/ref/pcp_recovery_node.sgml         |   80 +-
> doc.ja/src/sgml/ref/pcp_stop_pgpool.sgml           |  114 +-
> doc.ja/src/sgml/ref/pcp_watchdog_info.sgml         |  332 +-
> doc.ja/src/sgml/ref/pg_md5.sgml                    |  188 +-
> doc.ja/src/sgml/ref/pgpool.sgml                    |  464 +-
> .../src/sgml/ref/pgpool_adm_pcp_attach_node.sgml   |  168 +-
> .../src/sgml/ref/pgpool_adm_pcp_detach_node.sgml   |  196 +-
> doc.ja/src/sgml/ref/pgpool_adm_pcp_node_count.sgml |  136 +-
> doc.ja/src/sgml/ref/pgpool_adm_pcp_node_info.sgml  |  174 +-
> .../src/sgml/ref/pgpool_adm_pcp_pool_status.sgml   |  160 +-
> doc.ja/src/sgml/ref/pgpool_reset.sgml              |   82 +-
> doc.ja/src/sgml/ref/pgpool_set.sgml                |   46 +-
> doc.ja/src/sgml/ref/pgpool_setup.sgml              |  616 +-
> doc.ja/src/sgml/ref/pgpool_show.sgml               |  262 +-
> doc.ja/src/sgml/ref/show_pool_cache.sgml           |  108 +-
> doc.ja/src/sgml/ref/show_pool_nodes.sgml           |  130 +-
> doc.ja/src/sgml/ref/show_pool_pools.sgml           |  810 +-
> doc.ja/src/sgml/ref/show_pool_processes.sgml       |  276 +-
> doc.ja/src/sgml/ref/show_pool_status.sgml          |  106 +-
> doc.ja/src/sgml/ref/show_pool_version.sgml         |  102 +-
> doc.ja/src/sgml/ref/watchdog_setup.sgml            |  880 +-
> doc.ja/src/sgml/reference.sgml                     |  568 +-
> doc.ja/src/sgml/release-3.1.sgml                   |  124 +-
> doc.ja/src/sgml/release-3.2.sgml                   |  458 +-
> doc.ja/src/sgml/release-3.3.sgml                   | 1146 +--
> doc.ja/src/sgml/release-3.4.sgml                   | 3102 +++----
> doc.ja/src/sgml/release-3.5.sgml                   | 5076 +++++------
> doc.ja/src/sgml/release-3.6.sgml                   | 9180 ++++++++++----------
> doc.ja/src/sgml/release.sgml                       |  108 +-
> doc.ja/src/sgml/restrictions.sgml                  |  682 +-
> doc.ja/src/sgml/runtime.sgml                       |  824 +-
> doc.ja/src/sgml/ssl.sgml                           |  462 +-
> doc.ja/src/sgml/start.sgml                         | 1104 +--
> doc.ja/src/sgml/stream-check.sgml                  |  554 +-
> doc.ja/src/sgml/watchdog.sgml                      | 2186 ++---
> doc/src/sgml/advanced.sgml                         | 1238 +--
> doc/src/sgml/client-auth.sgml                      |  342 +-
> doc/src/sgml/config.sgml                           |  248 +-
> doc/src/sgml/connection-pooling.sgml               | 1388 +--
> doc/src/sgml/connection-settings.sgml              | 1966 ++---
> doc/src/sgml/errcodes-table.sgml                   | 1012 +--
> doc/src/sgml/examples.sgml                         | 3436 ++++----
> doc/src/sgml/failover.sgml                         |  924 +-
> doc/src/sgml/healthcheck.sgml                      |  312 +-
> doc/src/sgml/history.sgml                          |   44 +-
> doc/src/sgml/installation-rpm.sgml                 |  246 +-
> doc/src/sgml/installation-tips.sgml                |   76 +-
> doc/src/sgml/installation.sgml                     |  688 +-
> doc/src/sgml/intro.sgml                            |  238 +-
> doc/src/sgml/loadbalance.sgml                      | 1256 +--
> doc/src/sgml/memcache.sgml                         |  918 +-
> doc/src/sgml/misc-config.sgml                      |  326 +-
> doc/src/sgml/online-recovery.sgml                  |  674 +-
> doc/src/sgml/pgpool.sgml                           |   80 +-
> doc/src/sgml/ref/pcp_attach_node.sgml              |   48 +-
> doc/src/sgml/ref/pcp_common_options.sgml           |  206 +-
> doc/src/sgml/ref/pcp_detach_node.sgml              |   66 +-
> doc/src/sgml/ref/pcp_node_count.sgml               |   30 +-
> doc/src/sgml/ref/pcp_node_info.sgml                |  110 +-
> doc/src/sgml/ref/pcp_pool_status.sgml              |   46 +-
> doc/src/sgml/ref/pcp_proc_count.sgml               |   12 +-
> doc/src/sgml/ref/pcp_proc_info.sgml                |  134 +-
> doc/src/sgml/ref/pcp_promote_node.sgml             |   66 +-
> doc/src/sgml/ref/pcp_recovery_node.sgml            |   50 +-
> doc/src/sgml/ref/pcp_stop_pgpool.sgml              |   64 +-
> doc/src/sgml/ref/pcp_watchdog_info.sgml            |  202 +-
> doc/src/sgml/ref/pg_md5.sgml                       |  146 +-
> doc/src/sgml/ref/pgpool.sgml                       |  304 +-
> doc/src/sgml/ref/pgpool_adm_pcp_attach_node.sgml   |  114 +-
> doc/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml   |  136 +-
> doc/src/sgml/ref/pgpool_adm_pcp_node_count.sgml    |   88 +-
> doc/src/sgml/ref/pgpool_adm_pcp_node_info.sgml     |  120 +-
> doc/src/sgml/ref/pgpool_adm_pcp_pool_status.sgml   |  112 +-
> doc/src/sgml/ref/pgpool_reset.sgml                 |   42 +-
> doc/src/sgml/ref/pgpool_set.sgml                   |   30 +-
> doc/src/sgml/ref/pgpool_setup.sgml                 |  472 +-
> doc/src/sgml/ref/pgpool_show.sgml                  |  202 +-
> doc/src/sgml/ref/show_pool_cache.sgml              |  102 +-
> doc/src/sgml/ref/show_pool_nodes.sgml              |   96 +-
> doc/src/sgml/ref/show_pool_pools.sgml              |  734 +-
> doc/src/sgml/ref/show_pool_processes.sgml          |  224 +-
> doc/src/sgml/ref/show_pool_status.sgml             |   92 +-
> doc/src/sgml/ref/show_pool_version.sgml            |   82 +-
> doc/src/sgml/ref/watchdog_setup.sgml               |  740 +-
> doc/src/sgml/reference.sgml                        |  464 +-
> doc/src/sgml/release-3.1.sgml                      |  104 +-
> doc/src/sgml/release-3.2.sgml                      |  468 +-
> doc/src/sgml/release-3.3.sgml                      |  882 +-
> doc/src/sgml/release-3.4.sgml                      | 2068 ++---
> doc/src/sgml/release-3.5.sgml                      | 3682 ++++----
> doc/src/sgml/release-3.6.sgml                      | 6634 +++++++-------
> doc/src/sgml/release.sgml                          |   74 +-
> doc/src/sgml/restrictions.sgml                     |  400 +-
> doc/src/sgml/runtime.sgml                          |  578 +-
> doc/src/sgml/ssl.sgml                              |  292 +-
> doc/src/sgml/start.sgml                            |  862 +-
> doc/src/sgml/stream-check.sgml                     |  366 +-
> doc/src/sgml/watchdog.sgml                         | 1290 +--
> 130 files changed, 46668 insertions(+), 46668 deletions(-)
> 


More information about the pgpool-hackers mailing list