Skip to content

Commit 4dafa28

Browse files
committed
Doc: wrap long lines, tweaks
1 parent 813065c commit 4dafa28

File tree

2 files changed

+47
-19
lines changed

2 files changed

+47
-19
lines changed

docs/CONFIGURING.SourceSVN.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ with regard to installing SourceIntegration plugins.
2626

2727
3. Click the *Source Control Integration* link.
2828

29-
4. Scroll down the page until you see the section *Source Subversion Integration*. There are currently 4 options to configure.
29+
4. Scroll down the page until you see the section *Source Subversion Integration*.
30+
There are currently 4 options to configure.
3031

3132
| Option | Notes |
3233
| ------------------------ | -------------- |
@@ -47,16 +48,30 @@ with regard to installing SourceIntegration plugins.
4748
- Select *SVN* from the *Type* pop-up menu.
4849
- Click the *Create Repository* button.
4950

50-
3. This will take you to the *Update Repository* page where you'll need to fill in all the details for the repository:
51+
3. This will take you to the *Update Repository* page where you'll need to fill
52+
in all the details for the repository:
5153

5254
- The *Name* field should be pre-populated with the name you entered in Step 2a above.
53-
- Paste in the SVN repository's URL in the *URL* field (e.g. `https://localhost.localdomain/repos/myrepo` or `file:///var/repos/myrepo`).
54-
- If access controls are configured on your SVN repository such that anonymous read access is not permitted, within the *SVN Username* and *SVN Password*, enter appropriate credentials that have read access to the repo.
55-
- If you use a "standard" repository layout, where the top-level of the repository contains `/trunk`, `/branches` and `/tags`, then enable the *Standard Repository option
56-
- If you use a non-standard repository layout, enter the path to the *trunk*, *branches* and *tags* directories into the following 3 option fields, e.g. `/my_new_product/trunk`, `/my_new_product/branches`, `/my_new_product/tags`. See the [SVN book](http://svnbook.red-bean.com/en/1.5/svn.branchmerge.maint.html) for more details of repository layouts
57-
- If you use a non-standard repository layout and you want to ignore commits to the repository that are not changing files within the *Trunk Path*, *Branch Path* or *Tag Path* directories (which is the most likely case), then enable the *Ignore Other Paths* option.
55+
- Paste in the SVN repository's URL in the *URL* field (e.g.
56+
`https://localhost.localdomain/repos/myrepo` or `file:///var/repos/myrepo`).
57+
- If access controls are configured on your SVN repository such that anonymous
58+
read access is not permitted, within the *SVN Username* and *SVN Password*,
59+
enter appropriate credentials that have read access to the repo.
60+
- If you use a "standard" repository layout, where the top-level of the
61+
repository contains `/trunk`, `/branches` and `/tags`, then enable the
62+
*Standard Repository option
63+
- If you use a non-standard repository layout, enter the path to the *trunk*,
64+
*branches* and *tags* directories into the following 3 option fields, e.g.
65+
`/my_new_product/trunk`, `/my_new_product/branches`, `/my_new_product/tags`.
66+
See the [SVN book](http://svnbook.red-bean.com/en/1.5/svn.branchmerge.maint.html)
67+
for more details of repository layouts
68+
- If you use a non-standard repository layout and you want to ignore commits
69+
to the repository that are not changing files within the *Trunk Path*,
70+
*Branch Path* or *Tag Path* directories (which is the most likely case),
71+
then enable the *Ignore Other Paths* option.
5872
- Click the *Update Repository* button.
5973

60-
4. Click the *Import Everything* button to test connectivity and perform an initial import of the repository changesets.
74+
4. Click the *Import Everything* button to test connectivity and perform an
75+
initial import of the repository changesets.
6176

6277
**Note:** This may take a long time or even fail for large repositories.

docs/CONFIGURING.SourceViewVC.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ See the [README](../README.md#installation) for overall instructions.
1919

2020
## Configuration of SVN
2121

22-
See [SourceSVN](CONFIGURING.SourceSVN.md#configuration-of-the-plugin)
22+
See [SourceSVN configuration](CONFIGURING.SourceSVN.md#configuration-of-the-plugin).
2323

2424
## Configuration of a Repository
2525

@@ -31,19 +31,32 @@ See [SourceSVN](CONFIGURING.SourceSVN.md#configuration-of-the-plugin)
3131
- Select *ViewVC* from the *Type* pop-up menu.
3232
- Click the *Create Repository* button.
3333

34-
3. This will take you to the *Update Repository* page where you'll need to fill in all the details for the repository:
34+
3. This will take you to the *Update Repository* page where you'll need to fill
35+
in all the details for the repository:
3536

3637
- The *Name* field should be pre-populated with the name you entered in Step 2a above.
37-
- Paste in the SVN repository's URL in the *URL* field (e.g. `https://localhost.localdomain/repos/myrepo` or `file:///var/repos/myrepo`).
38-
- Paste in the ViewVC installation's root URL in the *ViewVC URL* field (e.g. `http://viewvc-server/viewvc/`).
39-
- Enter the name of the SVN repository, as it appears in the list seen in ViewVC, in the *ViewVC Name* field (e.g. `myrepo`).
40-
- If the ViewVC installation has the `root_as_url_component` option enabled (see the `viewvc.conf` file) then enable the *ViewVC Root As URL Component Enabled?* field.
41-
- If the ViewVC installation has the checkout view enabled (the `allowed_views` field list includes `co` in the `viewvc.conf` file) then enable the *ViewVC Checkout View Enabled?* field.
42-
- Enter the username of a user which has read access to the SVN repository in the *SVN Username* field (e.g. "repo-user").
43-
- Enter the password for the user in the *SVN Password* field (e.g. "Sup4rSecre7").
44-
- If your repository is configured with the standard `trunk`, `branches` & `tags` folders at the top-level, select the *Standard Repository* field, otherwise enter the appropriate paths into the *Trunk Path*, *Branch Path* and *Tag Path* fields.
38+
- Paste in the SVN repository's URL in the *URL* field
39+
(e.g. `https://localhost.localdomain/repos/myrepo` or `file:///var/repos/myrepo`).
40+
- Paste in the ViewVC installation's root URL in the *ViewVC URL* field
41+
(e.g. `http://viewvc-server/viewvc/`).
42+
- Enter the name of the SVN repository, as it appears in the list seen in
43+
ViewVC, in the *ViewVC Name* field (e.g. `myrepo`).
44+
- If the ViewVC installation has the `root_as_url_component` option enabled
45+
(see the `viewvc.conf` file) then enable the *ViewVC Root As URL Component Enabled?*
46+
field.
47+
- If the ViewVC installation has the checkout view enabled (the `allowed_views`
48+
field list includes `co` in the `viewvc.conf` file) then check the
49+
*ViewVC Checkout View Enabled?* field.
50+
- Enter the username of a user which has read access to the SVN repository in
51+
the *SVN Username* field (e.g. "repo-user").
52+
- Enter the password for the user in the *SVN Password* field (e.g. "Sup4rSecre7!").
53+
- If your repository is configured with the standard `trunk`, `branches` &
54+
`tags` folders at the top-level, select the *Standard Repository* field,
55+
otherwise enter the appropriate paths into the *Trunk Path*, *Branch Path*
56+
and *Tag Path* fields.
4557
- Click the *Update Repository* button.
4658

47-
4. Click the *Import Everything* button to test connectivity and perform an initial import of the repository changesets.
59+
4. Click the *Import Everything* button to test connectivity and perform an
60+
initial import of the repository changesets.
4861

4962
**Note:** This may take a long time or even fail for large repositories.

0 commit comments

Comments
 (0)