Patchwork [STABLE] README: make paragraphs before example code end with "::" for reST syntax

login
register
mail settings
Submitter Katsunori FUJIWARA
Date July 31, 2017, 2:14 p.m.
Message ID <fe33ab21105ba2476131.1501510485@speaknoevil>
Download mbox | patch
Permalink /patch/22586/
State Accepted
Headers show

Comments

Katsunori FUJIWARA - July 31, 2017, 2:14 p.m.
# HG changeset patch
# User FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
# Date 1501505273 -32400
#      Mon Jul 31 21:47:53 2017 +0900
# Branch stable
# Node ID fe33ab21105ba2476131c7b078d905a1f2f7efcf
# Parent  92f7dcf9a40b056573be89f611e1f093521696d7
# Available At https://bitbucket.org/foozy/mercurial-wip
#              hg pull https://bitbucket.org/foozy/mercurial-wip -r fe33ab21105b
# EXP-Topic doc-improvement-hg43
README: make paragraphs before example code end with "::" for reST syntax

After this patch, README as reST text can be rendered into HTML more
appropriately. This is useful for hosting servers, which render README
file as a part of index HTML of its directory (for example,
Bitbucket).
Augie Fackler - Aug. 1, 2017, 8:23 p.m.
On Mon, Jul 31, 2017 at 11:14:45PM +0900, FUJIWARA Katsunori wrote:
> # HG changeset patch
> # User FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
> # Date 1501505273 -32400
> #      Mon Jul 31 21:47:53 2017 +0900
> # Branch stable
> # Node ID fe33ab21105ba2476131c7b078d905a1f2f7efcf
> # Parent  92f7dcf9a40b056573be89f611e1f093521696d7
> # Available At https://bitbucket.org/foozy/mercurial-wip
> #              hg pull https://bitbucket.org/foozy/mercurial-wip -r fe33ab21105b
> # EXP-Topic doc-improvement-hg43
> README: make paragraphs before example code end with "::" for reST syntax

Queued for stable, thanks.

>
> After this patch, README as reST text can be rendered into HTML more
> appropriately. This is useful for hosting servers, which render README
> file as a part of index HTML of its directory (for example,
> Bitbucket).
>
> diff --git a/README b/README
> --- a/README
> +++ b/README
> @@ -4,14 +4,14 @@ Mercurial
>  Mercurial is a fast, easy to use, distributed revision control tool
>  for software developers.
>
> -Basic install:
> +Basic install::
>
>   $ make            # see install targets
>   $ make install    # do a system-wide install
>   $ hg debuginstall # sanity-check setup
>   $ hg              # see help
>
> -Running without installing:
> +Running without installing::
>
>   $ make local      # build for inplace usage
>   $ ./hg --version  # should show the latest version
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel@mercurial-scm.org
> https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel

Patch

diff --git a/README b/README
--- a/README
+++ b/README
@@ -4,14 +4,14 @@  Mercurial
 Mercurial is a fast, easy to use, distributed revision control tool
 for software developers.
 
-Basic install:
+Basic install::
 
  $ make            # see install targets
  $ make install    # do a system-wide install
  $ hg debuginstall # sanity-check setup
  $ hg              # see help
 
-Running without installing:
+Running without installing::
 
  $ make local      # build for inplace usage
  $ ./hg --version  # should show the latest version