Patchwork [4,of,7,STABLE] hg-ssh: copy doc string to man page

login
register
mail settings
Submitter Sean Farley
Date May 1, 2016, 7:12 a.m.
Message ID <60d96ee76151c3308706.1462086724@laptop.local>
Download mbox | patch
Permalink /patch/14849/
State Superseded
Commit 7b52cb384c3851f9869a1609c537ce3c7d5a7bd1
Headers show

Comments

Sean Farley - May 1, 2016, 7:12 a.m.
# HG changeset patch
# User Sean Farley <sean@farley.io>
# Date 1462063658 25200
#      Sat Apr 30 17:47:38 2016 -0700
# Branch stable
# Node ID 60d96ee76151c33087068443af42cacfe8a5391e
# Parent  23e884cfdd6d77cc3878f87d2c7542c795f5dedb
# EXP-Topic docker-ppa
hg-ssh: copy doc string to man page

This corrects a warning from lintian that we're shipping an executable without
a man page. Since there is a doc string in the text, let's use that for the man
page.
Yuya Nishihara - May 1, 2016, 9:12 a.m.
On Sun, 01 May 2016 00:12:04 -0700, Sean Farley wrote:
> # HG changeset patch
> # User Sean Farley <sean@farley.io>
> # Date 1462063658 25200
> #      Sat Apr 30 17:47:38 2016 -0700
> # Branch stable
> # Node ID 60d96ee76151c33087068443af42cacfe8a5391e
> # Parent  23e884cfdd6d77cc3878f87d2c7542c795f5dedb
> # EXP-Topic docker-ppa
> hg-ssh: copy doc string to man page
> 
> This corrects a warning from lintian that we're shipping an executable without
> a man page. Since there is a doc string in the text, let's use that for the man
> page.
> 
> diff --git a/doc/gendoc.py b/doc/gendoc.py
> --- a/doc/gendoc.py
> +++ b/doc/gendoc.py
> @@ -134,10 +134,11 @@ def showdoc(ui):
>  
>  def showtopic(ui, topic):
>      extrahelptable = [
>          (["common"], '', loaddoc('common')),
>          (["hg.1"], '', loaddoc('hg.1')),
> +        (["hg-ssh.1"], '', loaddoc('hg-ssh.1')),

It appears the official Debian package puts it in the section 8.

http://manpages.ubuntu.com/manpages/xenial/man8/hg-ssh.8.html
Sean Farley - May 1, 2016, 5:48 p.m.
Yuya Nishihara <yuya@tcha.org> writes:

> On Sun, 01 May 2016 00:12:04 -0700, Sean Farley wrote:
>> # HG changeset patch
>> # User Sean Farley <sean@farley.io>
>> # Date 1462063658 25200
>> #      Sat Apr 30 17:47:38 2016 -0700
>> # Branch stable
>> # Node ID 60d96ee76151c33087068443af42cacfe8a5391e
>> # Parent  23e884cfdd6d77cc3878f87d2c7542c795f5dedb
>> # EXP-Topic docker-ppa
>> hg-ssh: copy doc string to man page
>> 
>> This corrects a warning from lintian that we're shipping an executable without
>> a man page. Since there is a doc string in the text, let's use that for the man
>> page.
>> 
>> diff --git a/doc/gendoc.py b/doc/gendoc.py
>> --- a/doc/gendoc.py
>> +++ b/doc/gendoc.py
>> @@ -134,10 +134,11 @@ def showdoc(ui):
>>  
>>  def showtopic(ui, topic):
>>      extrahelptable = [
>>          (["common"], '', loaddoc('common')),
>>          (["hg.1"], '', loaddoc('hg.1')),
>> +        (["hg-ssh.1"], '', loaddoc('hg-ssh.1')),
>
> It appears the official Debian package puts it in the section 8.
>
> http://manpages.ubuntu.com/manpages/xenial/man8/hg-ssh.8.html

Ah, thanks!

Patch

diff --git a/doc/gendoc.py b/doc/gendoc.py
--- a/doc/gendoc.py
+++ b/doc/gendoc.py
@@ -134,10 +134,11 @@  def showdoc(ui):
 
 def showtopic(ui, topic):
     extrahelptable = [
         (["common"], '', loaddoc('common')),
         (["hg.1"], '', loaddoc('hg.1')),
+        (["hg-ssh.1"], '', loaddoc('hg-ssh.1')),
         (["hgignore.5"], '', loaddoc('hgignore.5')),
         (["hgrc.5"], '', loaddoc('hgrc.5')),
         (["hgignore.5.gendoc"], '', loaddoc('hgignore')),
         (["hgrc.5.gendoc"], '', loaddoc('config')),
     ]
diff --git a/mercurial/help/hg-ssh.1.txt b/mercurial/help/hg-ssh.1.txt
new file mode 100644
--- /dev/null
+++ b/mercurial/help/hg-ssh.1.txt
@@ -0,0 +1,72 @@ 
+========
+ hg-ssh
+========
+
+---------------------------------------
+Mercurial hg-ssh wrapper for ssh access
+---------------------------------------
+
+:Author:         Thomas Arendsen Hein <thomas@intevation.de>
+:Organization:   Mercurial
+:Manual section: 1
+:Manual group:   Mercurial Manual
+
+.. contents::
+   :backlinks: top
+   :class: htmlonly
+   :depth: 1
+
+
+Synopsis
+""""""""
+**hg-ssh** path/to/repo1 path/to/repo2 ...
+
+Description
+"""""""""""
+**hg-ssh** is a wrapper for ssh access to a limited set of mercurial repos.
+
+To be used in ~/.ssh/authorized_keys with the "command" option, see sshd(8):
+command="hg-ssh path/to/repo1 /path/to/repo2 ~/repo3 ~user/repo4" ssh-dss ...
+(probably together with these other useful options:
+no-port-forwarding,no-X11-forwarding,no-agent-forwarding)
+
+This allows pull/push over ssh from/to the repositories given as arguments.
+
+If all your repositories are subdirectories of a common directory, you can
+allow shorter paths with:
+command="cd path/to/my/repositories && hg-ssh repo1 subdir/repo2"
+
+You can use pattern matching of your normal shell, e.g.:
+command="cd repos && hg-ssh user/thomas/* projects/{mercurial,foo}"
+
+You can also add a --read-only flag to allow read-only access to a key, e.g.:
+command="hg-ssh --read-only repos/\*"
+
+Bugs
+""""
+Probably lots, please post them to the mailing list (see Resources_
+below) when you find them.
+
+See Also
+""""""""
+|hg(1)|_
+
+Author
+""""""
+Written by Matt Mackall <mpm@selenic.com>
+
+Resources
+"""""""""
+Main Web Site: https://mercurial-scm.org/
+
+Source code repository: http://selenic.com/hg
+
+Mailing list: http://selenic.com/mailman/listinfo/mercurial
+
+Copying
+"""""""
+Copyright (C) 2005-2016 Matt Mackall.
+Free use of this software is granted under the terms of the GNU General
+Public License version 2 or any later version.
+
+.. include:: common.txt