Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update outdated configuration options in documentation #290

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 17 additions & 20 deletions docs/user_guide/config_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,14 +232,14 @@ Entries for each CABLE branch to use. Each entry is a key-value pair and are lis

```yaml
realisations:
# head of the trunk (SVN)
# head of main branch
- repo:
svn:
branch_path: trunk
git:
branch: main
# some development branch
- repo:
svn:
branch_path: branches/Users/foo/my_branch
git:
branch: my_branch
patch:
cable:
cable_user:
Expand Down Expand Up @@ -379,9 +379,9 @@ realisations:
```yaml
realisations:
- repo:
svn:
branch_path: branches/Users/foo/my_branch
name: my_feature # (1)
git:
branch: my_branch
name: my_feature # (1)
```

1. Checkout the branch in the directory `src/my_feature`
Expand All @@ -392,10 +392,9 @@ realisations:

```yaml
realisations:
# head of the trunk
- path: trunk
# some development branch
- path: branches/Users/foo/my_branch
- repo:
git:
branch: my_branch
build_script: offline/build.sh
```

Expand All @@ -418,10 +417,9 @@ realisations:

```yaml
realisations:
# head of the trunk
- path: trunk
# some development branch
- path: branches/Users/foo/my_branch
- repo:
git:
branch: my_branch
patch: # (1)
cable:
cable_user:
Expand All @@ -437,10 +435,9 @@ realisations:

```yaml
realisations:
# head of the trunk
- path: trunk
# some development branch
- path: branches/Users/foo/my_branch
- repo:
git:
branch: my_branch
patch_remove:
cable:
soilparmnew: nil # (1)
Expand Down
Loading