Merge ~blr/turnip/+git/turnip:fix-rst-warnings into turnip:master

Proposed by Kit Randel on 2016-05-16
Status: Merged
Merged at revision: 4d48551e28f9979254b452eb9c41a821439e0f31
Proposed branch: ~blr/turnip/+git/turnip:fix-rst-warnings
Merge into: turnip:master
Diff against target: 102 lines (+12/-13)
4 files modified
Makefile (+1/-0)
README (+9/-9)
requirements.txt (+1/-0)
turnip/pack/ssh.py (+1/-4)
Reviewer Review Type Date Requested Status
Colin Watson 2016-05-16 Approve on 2016-05-16
Review via email: mp+294747@code.launchpad.net

Commit Message

* Correct invalid RST in README.
* Add RST validation to lint target.
* Add docutils 0.12.
* Remove unused import ConnectionDone.

Description of the Change

Pypi is not currently rendering the turnip readme correctly (https://pypi.python.org/pypi/turnip/0.1.1), as it contains invalid RST.

12:07 < lifeless> wgrant: https://pypi.python.org/pypi/turnip/0.1.1 <- note the rendering

Bzr prereq: https://code.launchpad.net/~blr/turnip/dependencies/+merge/294752

To post a comment you must log in.
Colin Watson (cjwatson) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/Makefile b/Makefile
2index b088b7a..80bf28c 100644
3--- a/Makefile
4+++ b/Makefile
5@@ -63,6 +63,7 @@ tags:
6
7 lint: $(ENV)
8 @$(FLAKE8) --exclude=__pycache__,version_info.py turnip
9+ $(PYTHON) setup.py check --restructuredtext --strict
10
11 run-api: $(ENV)
12 $(PSERVE) api.ini --reload
13diff --git a/README b/README
14index 2a13241..0d8528d 100644
15--- a/README
16+++ b/README
17@@ -13,7 +13,7 @@ None of the Python interfaces here should be considered stable.
18
19
20 Architecture
21-------------
22+============
23
24 turnip's architecture is designed to maximise simplicity, scalability
25 and robustness. Each server provides roughly one service, and an
26@@ -45,24 +45,24 @@ Backends:
27
28
29 Internal protocol
30------------------
31+=================
32
33 turnip uses an extension of the Git pack protocol for most communication
34 between its servers. The only change is that turnip requests can specify
35 arbitrary named parameters, not just a hostname.
36
37 The relevant part of the Git pack protocol's git-proto-request is
38-represented in ABNF as follows:
39+represented in ABNF as follows::
40
41 git-proto-request = request-command SP pathname NUL [ host-parameter NUL ]
42 host-parameter = "host=" hostname [ ":" port ]
43
44-turnip-proto-request alters it to this:
45+turnip-proto-request alters it to this::
46
47- turnip-proto-request = request-command SP pathname NUL *( param NUL )
48+ turnip-proto-request = request-command SP pathname NUL \*( param NUL )
49 param = param-name "=" param-value
50- param-name = *( %x01-3C / %x3E-FF ) ; exclude NUL and =
51- param-value = *%x01-FF ; exclude NUL
52+ param-name = \*( %x01-3C / %x3E-FF ) ; exclude NUL and =
53+ param-value = \*%x01-FF ; exclude NUL
54
55 The only additional parameters implemented today are
56 'turnip-stateless-rpc' and 'turnip-advertise-refs', which are used by
57@@ -70,7 +70,7 @@ the smart HTTP server to proxy to the standard pack protocol.
58
59
60 Development
61------------
62+===========
63
64 Pack smart-http/ssh services can be started with:
65
66@@ -82,7 +82,7 @@ The HTTP API can be started with:
67
68
69 Deployment
70-----------
71+==========
72
73 Turnip is deployed with the turnip juju charm, available from:
74
75diff --git a/requirements.txt b/requirements.txt
76index 636668b..eafd823 100644
77--- a/requirements.txt
78+++ b/requirements.txt
79@@ -2,6 +2,7 @@ beautifulsoup4==4.3.2
80 cffi==0.9.1
81 contextlib2==0.4.0
82 cornice==0.19.0
83+docutils==0.12
84 envdir==0.7
85 extras==0.0.3
86 fixtures==1.0.0
87diff --git a/turnip/pack/ssh.py b/turnip/pack/ssh.py
88index ebbf86a..006331d 100644
89--- a/turnip/pack/ssh.py
90+++ b/turnip/pack/ssh.py
91@@ -26,10 +26,7 @@ from twisted.internet import (
92 protocol,
93 reactor,
94 )
95-from twisted.internet.error import (
96- ConnectionDone,
97- ProcessTerminated,
98- )
99+from twisted.internet.error import ProcessTerminated
100 from twisted.python import (
101 components,
102 failure,

Subscribers

People subscribed via source and target branches