Revise Readme (#267)

iesahin · Feb 18, 2025 · 7251807 · 7251807
1 parent befbaa0
commit 7251807
Show file tree

Hide file tree

Showing 17 changed files with 395 additions and 149 deletions.
diff --git a/README.md b/README.md
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -33,6 +33,7 @@
     - [`xvc file carry-in`](./ref/xvc-file-carry-in.md)
     - [`xvc file send`](./ref/xvc-file-send.md)
     - [`xvc file bring`](./ref/xvc-file-bring.md)
+    - [`xvc file share`](./ref/xvc-file-share.md)
     - [`xvc file move`](./ref/xvc-file-move.md)
     - [`xvc file copy`](./ref/xvc-file-copy.md)
     - [`xvc file remove`](./ref/xvc-file-remove.md)

diff --git a/book/src/ref/xvc-file-share.md b/book/src/ref/xvc-file-share.md
@@ -1,4 +1,4 @@
-# xvc file send
+# xvc file share
 
 ## Synopsis
 

diff --git a/book/src/ref/xvc-pipeline-step-dependency-file.md b/book/src/ref/xvc-pipeline-step-dependency-file.md
@@ -1,4 +1,4 @@
-### File Dependencies
+### File
 
 This command works only in Xvc repositories.
 

diff --git a/book/src/ref/xvc-pipeline-step-dependency-generic.md b/book/src/ref/xvc-pipeline-step-dependency-generic.md
@@ -1,4 +1,4 @@
-### Generic Command Dependencies
+### Generic Command
 
 This command works only in Xvc repositories.
 

diff --git a/book/src/ref/xvc-pipeline-step-dependency-glob-items.md b/book/src/ref/xvc-pipeline-step-dependency-glob-items.md
@@ -1,4 +1,4 @@
-### Glob Items Dependency
+### Glob Items
 
 A step can depend on multiple files specified with globs. When any of the files change, or a new file is added or
 removed from the files specified by glob, the step is invalidated.

diff --git a/book/src/ref/xvc-pipeline-step-dependency-glob.md b/book/src/ref/xvc-pipeline-step-dependency-glob.md
@@ -1,4 +1,4 @@
-### Glob Dependencies
+### Glob
 
 A step can depend on multiple files specified with globs. The difference with
 this and [glob-items dependency](./xvc-pipeline-step-dependency-glob-items.md)

diff --git a/book/src/ref/xvc-pipeline-step-dependency-line-items.md b/book/src/ref/xvc-pipeline-step-dependency-line-items.md
@@ -1,4 +1,4 @@
-### Line Item Dependencies
+### Line Items
 
 You can make your steps to depend on lines of text files. The lines are defined by starting and ending indices.
 

diff --git a/book/src/ref/xvc-pipeline-step-dependency-lines.md b/book/src/ref/xvc-pipeline-step-dependency-lines.md
@@ -1,4 +1,4 @@
-### Line Dependencies
+### Line
 
 You can make your steps to depend on lines of text files. The lines are defined by starting and ending indices.
 

diff --git a/book/src/ref/xvc-pipeline-step-dependency-param.md b/book/src/ref/xvc-pipeline-step-dependency-param.md
@@ -1,4 +1,4 @@
-### (Hyper-)Parameter Dependencies
+### (Hyper-)Parameter
 
 You may be keeping pipeline-wide parameters in structured text files. You can specify such parameters found in JSON,
 TOML and YAML files as dependencies.

diff --git a/book/src/ref/xvc-pipeline-step-dependency-regex-items.md b/book/src/ref/xvc-pipeline-step-dependency-regex-items.md
@@ -1,4 +1,4 @@
-### Regex Item Dependencies
+### Regex Items
 
 You can specify a regular expression matched against the lines from a file as a dependency. The step is invalidated when
 the matched results changed.

diff --git a/book/src/ref/xvc-pipeline-step-dependency-regex.md b/book/src/ref/xvc-pipeline-step-dependency-regex.md
@@ -1,4 +1,4 @@
-### Regex Dependencies
+### Regex
 
 You can specify a regular expression matched against the lines from a file as a dependency. The step is invalidated when
 the matched results changed.

diff --git a/book/src/ref/xvc-pipeline-step-dependency-sqlite-query.md b/book/src/ref/xvc-pipeline-step-dependency-sqlite-query.md
@@ -1,4 +1,4 @@
-### SQLite Query Dependency
+### SQLite Query
 
 You can create a step dependency with an SQLite query. When the query results
 change, the step is invalidated.

diff --git a/book/src/ref/xvc-pipeline-step-dependency-step.md b/book/src/ref/xvc-pipeline-step-dependency-step.md
@@ -1,5 +1,4 @@
-
-### Step Dependencies
+### Step
 
 This command works only in Xvc repositories.
 

diff --git a/book/src/ref/xvc-pipeline-step-dependency-url.md b/book/src/ref/xvc-pipeline-step-dependency-url.md
@@ -1,4 +1,4 @@
-### URL Dependencies
+### URL
 
 This command works only in Xvc repositories.
 

diff --git a/run-tests.zsh b/run-tests.zsh
@@ -1,6 +1,6 @@
 # LLVM_PROFILE_FILE="${TMPDIR}/xvc-%p-%m.profraw" CARGO_INCREMENTAL=0 RUSTFLAGS="-Cinstrument-coverage" XVC_TRYCMD_TESTS=storage,file,pipeline,core,start TRYCMD=overwrite cargo llvm-cov --features test-ci --lcov --output-path lcov.info -p xvc # --test z_test_docs
 # rws is for local dev, run-with-secrets script
-# XVC_TRYCMD_TESTS=storage,file,pipeline,core,start TRYCMD=overwrite rws cargo test --features test-ci -p xvcr
+# XVC_TRYCMD_TESTS=storage,file,pipeline,core,start TRYCMD=overwrite rws cargo test --features test-ci -p xvc
 
 # XVC_TRYCMD_TESTS=storage,file,pipeline,core,start TRYCMD=overwrite cargo test --features test-ci -p xvc --test z_test_docs
 
diff --git a/rut-toolchain.toml → rust-toolchain.toml b/rut-toolchain.toml → rust-toolchain.toml