[PATCH] zeroconf: add extension documentation

David Soria Parra sn_ at gmx.net
Mon Jan 5 14:04:08 CST 2009


# HG changeset patch
# User David Soria Parra <dsp at php.net>
# Date 1231184952 -3600
# Node ID e86ca711544d14aa1abb5afdd336f772bf45b110
# Parent  3e592067515dcf3e9b027db089878f008a9f2550
zeroconf: add extension documentation

diff --git a/hgext/zeroconf/__init__.py b/hgext/zeroconf/__init__.py
--- a/hgext/zeroconf/__init__.py
+++ b/hgext/zeroconf/__init__.py
@@ -6,6 +6,29 @@
 # the GNU General Public License (version 2), incorporated herein by
 # reference.
 
+'''zeroconf support for mercurial repositories
+
+Zeroconf enabled repositories will be announced in a network without the need
+to configure a server or a service. They can be discovered without knowing
+their actual IP address.
+
+To use the zeroconf extension add the following entry to your hgrc file:
+
+[extensions]
+hgext.zeroconf =
+
+To allow other people to discover your repository using run "hg serve" in your
+repository.
+
+ $ cd test
+ $ hg serve
+
+You can discover zeroconf enabled repositories by running "hg paths".
+
+ $ hg paths
+ zc-test = http://example.com:8000/test
+'''
+
 import Zeroconf, socket, time, os
 from mercurial import ui
 from mercurial import extensions


More information about the Mercurial-devel mailing list