Spelling (#1419)

jsoref · web-flow · commit 1523457c3e0f · 2025-05-03T10:50:29.000+02:00
This pull request fixes various spelling mistakes across documentation, tests, and production code.

Corrects typos in comments and function names in the Go and Rust source files.
Fixes spelling errors in markdown documentation and GitHub workflow files.

---------

Signed-off-by: Josh Soref &lt;2119212+jsoref@users.noreply.github.com&gt;
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -8,7 +8,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
-  RUSTFLFAGS: "-D warnings"
+  RUSTFLAGS: "-D warnings"
 
 jobs:
   build:
diff --git a/README.md b/README.md
@@ -131,4 +131,4 @@ performing many requests to the main git host.
 
 ## FAQ
 
-See [here](https://josh-project.github.io/josh/faq.html)
+See the [FAQ](https://josh-project.github.io/josh/faq.html)
diff --git a/docs/src/contributing/testing.md b/docs/src/contributing/testing.md
@@ -16,7 +16,7 @@ cargo test --all
 Due to the fact that the integration tests need additional tools and a more complex
 environment and due to the fact that the integration test are done using [cram](https://pypi.org/project/cram/).
 you will need to crate an extra environment to run these tests. To simplify the
-setup of the integration testing we have setup a [Nix Shell](https://nixos.org/manual/nix/stable/#chap-installation) environment which
+setup of the integration testing we have set up a [Nix Shell](https://nixos.org/manual/nix/stable/#chap-installation) environment which
 you can start by using the following command if you have installed the [Nix Shell](https://nixos.org/manual/nix/stable/#chap-installation).
 
 **Attention:**
diff --git a/docs/src/faq.md b/docs/src/faq.md
@@ -12,7 +12,7 @@ Josh creates an alternate history that has no reference to the skipped parts. It
 
 ## How is it different from submodules?
 
-Where git submodules are multiple, independant repos, referencing each other with SHAs, Josh supports the monorepo approach.
+Where git submodules are multiple, independent repos, referencing each other with SHAs, Josh supports the monorepo approach.
 All of the code is in one single repo which can easily be kept in sync, and Josh provides any sub folder (or in the case of workspaces, more complicated recombination of folders) as their own git repository.
 These repos are transparently synchronised both ways with the main monorepo.
 Josh can thus do more than submodules can, and is easier and faster to use.
@@ -32,8 +32,8 @@ for the same purpose.
 Which one is right in more advanced use cases depends on your goals: `git filter-repo` offers more flexibility and options
 on what kind of filtering it supports, like rewriting commit messages or even plugging arbitrary scripts into the filtering.
 
-Josh uses a DSL instead of arbitary scripts for complex filters and is much more restrictive in the kind of filtering
-possilbe, but in exchange for those limitations offers incremental filtering as well as bidirectional operation, meaning converting changes between both the original and the filtered repos.
+Josh uses a DSL instead of arbitrary scripts for complex filters and is much more restrictive in the kind of filtering
+possible, but in exchange for those limitations offers incremental filtering as well as bidirectional operation, meaning converting changes between both the original and the filtered repos.
 
 ## How is Josh different from all of the above alternatives?
 
diff --git a/docs/src/guide/populate.sh b/docs/src/guide/populate.sh
@@ -41,7 +41,7 @@ cat > guide.c <<EOF
 #include "lib2.h"
 void main(void)
 {
-  printf("Answer to life, the universe, and everyting: %d, %d, %d\n", life(), universe(), everything());
+  printf("Answer to life, the universe, and everything: %d, %d, %d\n", life(), universe(), everything());
 }
 EOF
 git add .
@@ -56,7 +56,7 @@ cat > library2.md <<EOF
 Library2 provides the answer to the universe and everything
 EOF
 cat > guide.md <<EOF
-The guide project aimes to adress matters of life, universe, and everything.
+The guide project aims to address matters of life, universe, and everything.
 EOF
 git add .
 git commit -m "Add documentation"
diff --git a/docs/src/guide/workspaces.md b/docs/src/guide/workspaces.md
@@ -112,7 +112,7 @@ let's observe the result:
 {{#include workspaces.t:library_sync2}}
 ```
 
-After pushing and fetching the result, we see that it has been succesfully mapped by josh.
+After pushing and fetching the result, we see that it has been successfully mapped by josh.
 
 One suprising thing is the history: our "mapping" commit became a merge commit!
 This is because josh needs to merge the history of the module we want to map into the
@@ -135,7 +135,7 @@ no merge here.
 
 ### Interacting with workspaces
 
-Let's now create a second workspce, this time for application2.
+Let's now create a second workspace, this time for application2.
 It depends on library1 and library2.
 
 ```shell
@@ -179,7 +179,7 @@ We can push this change like any normal git change:
 ```
 
 Since the change was merged in the central repository, 
-a developper can now pull from the application1 workspace.
+a developer can now pull from the application1 workspace.
 
 ```shell
 {{#include workspaces.t:app1_pull}}
diff --git a/docs/src/intro.md b/docs/src/intro.md
@@ -64,7 +64,7 @@ cache.
 >can do that, it is a fairly expensive operation it's something you would do for example when you
 >import an old repository into a one huge git repository and then you can split it later on to be
 >multiple smaller ones, you can do it, what I am trying to say is that you should generally try to
->avoid it. It's not that git can not handle huge projects, git would not perform as well as it would
+>avoid it. It's not that git cannot handle huge projects, git would not perform as well as it would
 >otherwise. And you will have issues that you wish you didn't not have.
 >
 >So I am skipping this issue and going back to the performance issue. One of the things I want to
diff --git a/docs/src/reference/filters.md b/docs/src/reference/filters.md
@@ -13,7 +13,7 @@ Filters always begin with a colon and can be chained:
 
     :filter1:filter2
 
-When used as part of an URL filters can not contain white space or newlines. When read from a file
+When used as part of an URL filters cannot contain white space or newlines. When read from a file
 however white space can be inserted between filters (not after the leading colon).
 Additionally newlines can be used instead of ``,`` inside of composition filters.
 
@@ -66,7 +66,7 @@ workspace root as well as additional files specified in the ``workspace.josh`` f
 Applies the supplied regular expressions to every file in the input tree.
 
 ### Signature removal **`:unsign`**
-The default behaviour of Josh is to copy, if it exsists, the signature of the original commit in
+The default behaviour of Josh is to copy, if it exists, the signature of the original commit in
 the filtered commit. This makes the signature invalid, but allows a perfect round-trip: josh will be
 able to recreate the original commit from the filtered one.
 
diff --git a/docs/src/reference/workspace.md b/docs/src/reference/workspace.md
@@ -84,7 +84,7 @@ Remove a mapping
 
 To remove a mapping remove the corresponding entry from the ``workspace.josh`` file.
 The content of the previously shared path will stay in the workspace. That means the main
-repo will have two copies of that path from that point on. Effectivly creating a fork of that code.
+repo will have two copies of that path from that point on. Effectively creating a fork of that code.
 
 Remove a mapped path
 --------------------
diff --git a/docs/src/usecases.md b/docs/src/usecases.md
@@ -14,7 +14,7 @@ The partial repo will act as a normal git repository but only contain the files
 found in the subdirectory and only commits affecting those files.
 The partial repo supports both fetch as well as push operation.
 
-This helps not just to improve performace on the client due to having fewer files in
+This helps not just to improve performance on the client due to having fewer files in
 the tree,
 it also enables collaboration on parts of the monorepo with other parties
 utilizing git's normal distributed development features.
@@ -73,7 +73,7 @@ $ git clone http://josh/central.git:workspace=workspaces/project1.git
 
 Each of the subprojects defines a `workspace.josh` file, defining the mapping between the original central.git repository and the hierarchy in use inside of the project.
 
-In this setup, project1 and project2 can seemlessly depend on the latest version of library1, while only checking out the part of the central monorepo that's needed for their purpose.
+In this setup, project1 and project2 can seamlessly depend on the latest version of library1, while only checking out the part of the central monorepo that's needed for their purpose.
 What's more, any changes to a shared module will be synced in both directions.
 
 If a developer of the library1 pushed a new update, both projects will get the new version, and the developer will be able to check if they broke any test.
@@ -83,8 +83,8 @@ If a developer of project1 needs to update the library, the changes will be auto
 
 With everything stored in one repo, CI/CD systems only need to look into one source for each particular
 deliverable.
-However in traditional monorepo environments dependency mangement is handled by the build system.
-Build systems are usually taylored to specific languages and need their input already checked
+However in traditional monorepo environments dependency management is handled by the build system.
+Build systems are usually tailored to specific languages and need their input already checked
 out on the filesystem.
 So the question:
 
@@ -93,11 +93,11 @@ So the question:
 cannot be answered without cloning the entire repository and understanding how the languages
 used handle dependencies.
 
-In particular when using C familiy languages, hidden dependencies on header files are easy to miss.
+In particular when using C family languages, hidden dependencies on header files are easy to miss.
 For this reason limiting the visibility of files to the compiler by sandboxing is pretty much a requirement
 for reproducible builds.
 
-With Josh, each deliverable gets it's own virtual git repository with dependencies declared in the `workspace.josh`
+With Josh, each deliverable gets its own virtual git repository with dependencies declared in the `workspace.josh`
 file. This means answering the above question becomes as simple as comparing commit ids.
 Furthermore due to the tree filtering each build is guaranteed to be perfectly sandboxed
 and only sees those parts of the monorepo that have actually been mapped.
@@ -108,7 +108,7 @@ typically necessary with normal build tools.
 ### GraphQL API
 
 It is often desireable to access content stored in git without requiring a clone of the repository.
-This is usefull for CI/CD systems or web frontends such as dashboards.
+This is useful for CI/CD systems or web frontends such as dashboards.
 
 Josh exposes a GraphQL API for that purpose. For example, it can be used to find all workspaces currently
 present in the tree:
diff --git a/hyper_cgi/src/hyper_cgi.rs b/hyper_cgi/src/hyper_cgi.rs
@@ -9,9 +9,9 @@ use tokio::io::AsyncReadExt;
 use tokio::io::BufReader;
 use tokio::process::Command;
 
-/// do_cgi is an async function that takes an hyper request and a CGI compatible
+/// do_cgi is an async function that takes a hyper request and a CGI compatible
 /// command, and passes the request to be executed to the command.
-/// It then returns an hyper response and the stderr output of the command.
+/// It then returns a hyper response and the stderr output of the command.
 pub async fn do_cgi(
     req: Request<hyper::Body>,
     cmd: Command,
diff --git a/josh-core/src/filter/mod.rs b/josh-core/src/filter/mod.rs
@@ -711,7 +711,7 @@ fn apply_to_commit2(
                 }
                 if !ok_or!(is_ancestor_of(repo, id, *filter_tip), {
                     return Err(josh_error(&format!(
-                        "`:rev(...)` with non existing OID: {}",
+                        "`:rev(...)` with nonexistent OID: {}",
                         filter_tip
                     )));
                 }) {
diff --git a/josh-core/src/filter/parse.rs b/josh-core/src/filter/parse.rs
@@ -232,7 +232,7 @@ fn parse_workspace(filter_spec: &str) -> JoshResult<Vec<Filter>> {
     }
 }
 
-// Parse json string if neccessary
+// Parse json string if necessary
 fn unquote(s: &str) -> String {
     let s = s.replace("'", "\"");
     if let Ok(serde_json::Value::String(s)) = serde_json::from_str(&s) {
diff --git a/josh-core/src/history.rs b/josh-core/src/history.rs
@@ -82,9 +82,9 @@ fn find_unapply_base(
     filtered_to_original: &mut HashMap<git2::Oid, git2::Oid>,
     filter: filter::Filter,
     // When building the filtered_to_original mapping use this as a starting point
-    // for the search for orginals. If there are multiple originals that map to the
+    // for the search for originals. If there are multiple originals that map to the
     // same filtered commit (which is common) use one that is reachable from contained_in.
-    // Or, in other words, one that is contained in the the history of contained_in.
+    // Or, in other words, one that is contained in the history of contained_in.
     contained_in: git2::Oid,
     // Filtered OID to compare against
     filtered: git2::Oid,
diff --git a/josh-core/src/housekeeping.rs b/josh-core/src/housekeeping.rs
@@ -46,7 +46,7 @@ pub fn list_refs(
 }
 
 pub fn remember_filter(upstream_repo: &str, filter_spec: &str) {
-    // no need to rember the nop filter since we already keep a reference to
+    // no need to remember the nop filter since we already keep a reference to
     // the unfiltered branch in refs/josh/upstream
     if filter_spec != ":/" {
         if let Ok(mut known_filters) = KNOWN_FILTERS.try_lock() {
@@ -91,7 +91,7 @@ pub fn default_from_to(
         }
     }
 
-    // no need to rember the nop filter since we already keep a reference to
+    // no need to remember the nop filter since we already keep a reference to
     // the unfiltered branch in refs/josh/upstream
     if filter_spec != ":/" {
         if let Ok(mut known_filters) = KNOWN_FILTERS.try_lock() {
diff --git a/josh-proxy/src/bin/josh-proxy.rs b/josh-proxy/src/bin/josh-proxy.rs
@@ -1436,7 +1436,7 @@ async fn call_service(
     ))
     .await?;
 
-    // This is chained as a seperate future to make sure that
+    // This is chained as a separate future to make sure that
     // it is executed in all cases.
     std::mem::drop(temp_ns);
 
@@ -2065,7 +2065,7 @@ fn main() {
     // end in "/update" and this will not be a new server.
     // The update hook will then make a http request back to the main
     // process to do the actual computation while taking advantage of the
-    // cached data already loaded into the main processe's memory.
+    // cached data already loaded into the main process's memory.
     if let [a0, a1, a2, a3, ..] = &std::env::args().collect::<Vec<_>>().as_slice() {
         if a0.ends_with("/update") {
             std::process::exit(update_hook(a1, a2, a3).unwrap_or(1));
diff --git a/josh-proxy/src/lib.rs b/josh-proxy/src/lib.rs
@@ -198,7 +198,7 @@ pub fn process_repo_update(repo_update: RepoUpdate) -> josh::JoshResult<String>
         };
 
         let original_target_ref = if let Some(base) = &push_options.base {
-            // Allow user to use just the branchname as the base:
+            // Allow user to use just the branch name as the base:
             let full_path_base_refname =
                 transaction_mirror.refname(&format!("refs/heads/{}", base));
             if transaction_mirror
diff --git a/lfs-test-server/README.md b/lfs-test-server/README.md
@@ -68,7 +68,7 @@ To use the LFS test server with the Git LFS client, configure it in the reposito
 
 HTTPS:
 
-NOTE: If using https with a self signed cert also disable cert checking in the client repo.
+NOTE: If using https with a self-signed cert also disable cert checking in the client repo.
 
 ```
   [lfs]
@@ -126,7 +126,7 @@ bash run.sh
 
 ```
 
-Check the managment page
+Check the management page
 
 browser: https://localhost:9999/mgmt
 
diff --git a/lfs-test-server/content_store.go b/lfs-test-server/content_store.go
@@ -28,7 +28,7 @@ func NewContentStore(base string) (*ContentStore, error) {
 	return &ContentStore{base}, nil
 }
 
-// Get takes a Meta object and retreives the content from the store, returning
+// Get takes a Meta object and retrieves the content from the store, returning
 // it as an io.ReaderCloser. If fromByte > 0, the reader starts from that byte
 func (s *ContentStore) Get(meta *MetaObject, fromByte int64) (io.ReadCloser, error) {
 	path := filepath.Join(s.basePath, transformKey(meta.Oid))
diff --git a/lfs-test-server/content_store_test.go b/lfs-test-server/content_store_test.go
@@ -129,7 +129,7 @@ func TestContentStoreGetWithRange(t *testing.T) {
 	}
 }
 
-func TestContenStoreGetNonExisting(t *testing.T) {
+func TestContentStoreGetNonExisting(t *testing.T) {
 	setup()
 	defer teardown()
 
diff --git a/lfs-test-server/kvlogger.go b/lfs-test-server/kvlogger.go
@@ -66,7 +66,7 @@ func (l *KVLogger) Log(data kv) {
 	l.mu.Unlock()
 }
 
-// Fatal is equivalent to Log() follwed by a call to os.Exit(1)
+// Fatal is equivalent to Log() followed by a call to os.Exit(1)
 func (l *KVLogger) Fatal(data kv) {
 	l.Log(data)
 	os.Exit(1)
diff --git a/lfs-test-server/meta_store_test.go b/lfs-test-server/meta_store_test.go
@@ -17,7 +17,7 @@ func TestGetMeta(t *testing.T) {
 
 	meta, err := metaStoreTest.Get(&RequestVars{Oid: contentOid})
 	if err != nil {
-		t.Fatalf("Error retreiving meta: %s", err)
+		t.Fatalf("Error retrieving meta: %s", err)
 	}
 
 	if meta.Oid != contentOid {
@@ -44,7 +44,7 @@ func TestPutMeta(t *testing.T) {
 
 	meta, err = metaStoreTest.Get(&RequestVars{Oid: nonExistingOid})
 	if err != nil {
-		t.Errorf("expected to be able to retreive new put, got : %s", err)
+		t.Errorf("expected to be able to retrieve new put, got : %s", err)
 	}
 
 	if meta.Oid != nonExistingOid {
diff --git a/lfs-test-server/mgmt/templates/config.tmpl b/lfs-test-server/mgmt/templates/config.tmpl
@@ -13,7 +13,7 @@
 </pre>
 
 {{if eq .Config.Scheme "https"}}
-<p>Your server is configured to use https. If you're using self signed certificates, or are getting SSL errors, you can add the following to your <code>.gitconfig</code> file:</p>
+<p>Your server is configured to use https. If you're using self-signed certificates, or are getting SSL errors, you can add the following to your <code>.gitconfig</code> file:</p>
 <pre>
 <code>[http]
     sslverify = false
diff --git a/lfs-test-server/server.go b/lfs-test-server/server.go
@@ -45,7 +45,7 @@ type BatchResponse struct {
 	Objects  []*Representation `json:"objects"`
 }
 
-// Representation is object medata as seen by clients of the lfs server.
+// Representation is object metadata as seen by clients of the lfs server.
 type Representation struct {
 	Oid     string           `json:"oid"`
 	Size    int64            `json:"size"`
@@ -148,7 +148,7 @@ func (v *RequestVars) VerifyLink() string {
 	return fmt.Sprintf("%s%s", Config.ExtOrigin, path)
 }
 
-// link provides a structure used to build a hypermedia representation of an HTTP link.
+// link provides a structure used to build a hyper media representation of an HTTP link.
 type link struct {
 	Href      string            `json:"href"`
 	Header    map[string]string `json:"header,omitempty"`
diff --git a/lfs-test-server/server_test.go b/lfs-test-server/server_test.go
@@ -236,7 +236,7 @@ func TestPut(t *testing.T) {
 
 	r, err := testContentStore.Get(&MetaObject{Oid: contentOid}, 0)
 	if err != nil {
-		t.Fatalf("error retreiving from content store: %s", err)
+		t.Fatalf("error retrieving from content store: %s", err)
 	} else {
 		defer r.Close()
 	}
diff --git a/tester.sh b/tester.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# this script can be used to run tests in the container used for deployement.
+# this script can be used to run tests in the container used for deployment.
 # usage:
 #  Run all tests: ./tester.sh
 #  Run specific test: ./tester.sh path/to/test.t
@@ -41,7 +41,7 @@ if [[ ! -v CARGO_TARGET_DIR ]]; then
     exit 1
 fi
 
-export RUSTFLFAGS="-D warnings"
+export RUSTFLAGS="-D warnings"
 cargo build --workspace --exclude josh-ui --features hyper_cgi/test-server
 ( cd josh-ssh-dev-server ; go build -o "\${CARGO_TARGET_DIR}/josh-ssh-dev-server" )
 sh run-tests.sh ${TESTS}
diff --git a/tests/filter/ambiguous_merge.t b/tests/filter/ambiguous_merge.t
diff --git a/tests/filter/empty_reimport.t b/tests/filter/empty_reimport.t
@@ -48,11 +48,11 @@
   $ git checkout other_branch
   Switched to branch 'other_branch'
 
-  $ echo content > pre/blafile1
+  $ echo content > pre/blah-file1
   $ git add pre
   $ git commit -m "more change on other" 1> /dev/null
 
-  $ echo content > pre/blefile2
+  $ echo content > pre/blah-file2
   $ git add pre
   $ git commit -m "more change on other 2" 1> /dev/null
 
diff --git a/tests/filter/rev.t b/tests/filter/rev.t
diff --git a/tests/filter/subtree_prefix.t b/tests/filter/subtree_prefix.t
diff --git a/tests/proxy/empty_commit.t b/tests/proxy/empty_commit.t
diff --git a/tests/proxy/workspace_pre_history.t b/tests/proxy/workspace_pre_history.t

Original file line number	Diff line number	Diff line change
`@@ -131,4 +131,4 @@ performing many requests to the main git host.`
`131`	`131`
`132`	`132`	`## FAQ`
`133`	`133`
`134`		`-See [here](https://josh-project.github.io/josh/faq.html)`
	`134`	`+See the [FAQ](https://josh-project.github.io/josh/faq.html)`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ cache.`
`64`	`64`	`>can do that, it is a fairly expensive operation it's something you would do for example when you`
`65`	`65`	`>import an old repository into a one huge git repository and then you can split it later on to be`
`66`	`66`	`>multiple smaller ones, you can do it, what I am trying to say is that you should generally try to`
`67`		`->avoid it. It's not that git can not handle huge projects, git would not perform as well as it would`
	`67`	`+>avoid it. It's not that git cannot handle huge projects, git would not perform as well as it would`
`68`	`68`	`>otherwise. And you will have issues that you wish you didn't not have.`
`69`	`69`	`>`
`70`	`70`	`>So I am skipping this issue and going back to the performance issue. One of the things I want to`