docs: update sharing guide based (mostly) on marmoute's review
- don't claim certain scenarios are more/less common, just
simple/advanced
- mention code review as a multiple-developer scenario (not described
in detail yet!)
- suggest "hg config --edit --local" instead of "cat >> .hg/hgrc"
- use -q less often (and show resulting output)
- edit some section headers to be consistent with user guide
(example numbers; "amend" instead of "amending")
(These are just the small changes; big changes are yet to come.)
#!/usr/bin/env python
import os, os.path as op, re, sys
# line starts with two chars one of which is not a space (and both are not
# newlines obviously) and ends with one or more newlines followed by two spaces
# on a next line (indented text)
CODEBLOCK = re.compile(r'()\n(([^ \n][^\n]|[^\n][^ \n])[^\n]*)\n+ ')
INDEX = '''
Mercurial tests
===============
.. toctree::
:maxdepth: 1
'''
def rstify(orig, name):
header = '%s\n%s\n\n' % (name, '=' * len(name))
content = header + orig
content = CODEBLOCK.sub(r'\n\1\n\n::\n\n ', content)
return content
def main(base):
if os.path.isdir(base):
one_dir(base)
else:
one_file(base)
def one_dir(base):
index = INDEX
#doc = lambda x: op.join(op.dirname(__file__), 'docs', x)
for fn in sorted(os.listdir(base)):
if not fn.endswith('.t'):
continue
name = os.path.splitext(fn)[0]
content = one_file(op.join(base, fn))
target = op.join(base, name + '.rst')
#with file(doc(name + '.rst'), 'w') as f:
with file(target, 'w') as f:
f.write(content)
index += '\n ' + name
#with file(doc('index.rst'), 'w') as f:
# f.write(index)
def one_file(path):
name = os.path.basename(path)[:-2]
return rstify(file(path).read(), name)
if __name__ == '__main__':
if len(sys.argv) != 2:
print 'Please supply a path to tests dir as parameter'
sys.exit()
main(sys.argv[1])