Skip to content

Commit 1118f21

Browse files
committed
added more information for jannocoalesce
1 parent 4920aae commit 1118f21

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

trident.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -864,7 +864,8 @@ A most basic run may just include two arguments:
864864
```bash
865865
trident jannocoalesce \
866866
--sourceFile path/to/source.janno \
867-
--targetFile path/to/target.janno
867+
--targetFile path/to/target.janno \
868+
--outFile path/to/coalesced.janno
868869
```
869870

870871
`jannocoalesce` generally works by reading a source `.janno` file with `-s|--sourceFile` (or all `.janno` files in a `-d|--baseDir`) and a target `.janno` file with `-t|--targetFile`.
@@ -873,6 +874,14 @@ It then merges these files by a key column, which can be selected with `--source
873874

874875
`jannocoalesce` generally attempts to fill **all** empty cells in the target `.janno` file with information from the source. `--includeColumns` and `--excludeColumns` allow to select specific columns for which this should be done. In some cases it may be desirable to not just fill empty fields in the target, but overwrite the information already there with the `-f|--force` option. If the target file should be preserved, then the output can be directed to a new output `.janno` file with `-o|--outFile`.
875876

877+
Note that all three files, the source, the target, and the outfile, are mandatory. The roles are:
878+
879+
- `targetFile` -> This is the file which is taken as the starting point for the new janno file.
880+
- `sourceFile` -> This is the file from which to read additional columns that might be missing in the target.
881+
- `outFile` -> This is the file that will contain the coalesced result.
882+
883+
In addition to these three files, you can choose a Poseidon Version for both the source (`--pvSource`) and the target (`--pvTarget`), which is useful for backwards compatibility, in case you have Janno files in older Poseidon versions. **_But_**: Note that the output file will _always_ be written in the newest Poseidon version. Note that you _can_ choose the outFile to be the targetFile, which will then overwrite the target file. This can be useful if you know what you are doing. Otherwise it is of course safer to choose a new filename for the output.
884+
876885
## Rectify command
877886

878887
`rectify` automatically harmonizes POSEIDON.yml files of one or multiple packages. This is not an automatic update from one Poseidon version to the next, but rather a clean-up wizard after manual modifications. It also includes additional, automatic package editing features.

0 commit comments

Comments
 (0)