1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# How to use the scripts
## addNewVersionLink.sh
All the documentation files have a history of older versions.
When a new mayor or minor is created the top lines need to change
For example: the one in parenthesis is the latest version which is 3.2
```md
(`3.2 <https://docs.pgrouting.org/3.2/en/pgr_bipartite.html>`__)
`3.1 <https://docs.pgrouting.org/3.2/en/pgr_bipartite.html>`__
...
```
And needs to be 3.3:
```md
(`3.3 <https://docs.pgrouting.org/3.3/en/pgr_bipartite.html>`__)
`3.2 <https://docs.pgrouting.org/3.2/en/pgr_bipartite.html>`__
`3.1 <https://docs.pgrouting.org/3.2/en/pgr_bipartite.html>`__
...
```
To achieve, the change: from the root of the repository:
```bash
./tools/developer/addNewVersionLink.sh "3\.2" "3\.3"'
```
## commitByDirectory.sh
Some times legwork is done on a directory, for example when using the
`addNewVersionLink.sh` script
And for reviewing the pull request it is easier to do it by directory
From the root of the repository:
```bash
./tools/developer/commitByDirectory.sh doc "Updating links"
```
sub-directories without changes will be ignored
It will create a series of commits on sub-direcotries that were changed
for example the following commit messages will be created:
```bash
[doc/allpairs] Updating links
[doc/alpha_shape] Updating links
[doc/astar] Updating links
[doc/bdAstar] Updating links
...
[doc/transitiveClosure] Updating links
[doc/traversal] Updating links
[doc/trsp] Updating links
[doc/tsp] Updating links
[doc/version] Updating links
[doc/vrp_basic] Updating links
[doc/withPoints] Updating links
```
|
