Update docs (#34)

Co-authored-by: Matthew Asplund <[email protected]>

Docs/Architecture.md

@@ -8,7 +8,7 @@ The Soup Recipe is a property bag defined in the [toml](https://github.com/toml-
 Soup builds are fairly simple at their core. There are five phases.
 
 1. **Parse Recipe** - The Recipe toml file is read from disk.
-2. **Build Dependencies** - The build engine recursively builds all transient dependencies.
+2. **Build Dependencies** - The build engine recursively builds all trasitive dependencies.
 3. **Build Extensions** - The build engine recursively builds all build extension DLLs. The engine will then invoke the "RegisterBuildExtension" method that is exported from the Extension DLL.
 4. **Run Tasks** - The build engine will invoke all registered build tasks in their defined order (Note: this is still being worked on.) The Tasks can influence each other by reading and setting properties on the active state. A build task should not actually perform any commands itself, it will instead generate Build Commands which are self contained operation definitions with input/output files.
 5.  **Run Commands** - The final stage of the build is to execute the build commands that were generated from the build tasks. These commands contain the input and output files that will be used to perform incremental builds. (Note: There is currently a very simple time-stamp based incremental build that relies on the compiler to print all included files. There is an open question if this can be replaced with a better system that monitors the filesystem for changes, possibly BuildXL).

Docs/CLI.md

@@ -9,4 +9,8 @@ soup <command> [arguments]
 
 [Initialize](cli/initialize)
 
+[Install](cli/install)
+
+[Publish](cli/publish)
+
 [Version](cli/version)

Docs/CLI/Build.md

@@ -1,6 +1,6 @@
 # Build
 ## Overview
-Build a recipe and all transient dependencies.
+Build a recipe and all transitive dependencies.
 ```
 soup build <directory> [-flavor <name>|-force]
 ```

Docs/CLI/Install.md

@@ -1,13 +1,24 @@
-# Install packages
+# Install
+## Overview
+Install packages from the public feed.
+```
+soup install [<name>[@<version>]]
+```
 
-## Synopsis
+`<name>[@<version>]` - An optional parameter to specify the name and optional version of the package you would like to install. If not present then the install command will install all of the packages already in the recipe.
 
+## Examples
+Install all of the current external dependencies and build extension packages.
 ```
 soup install
-soup install <name>
-soup install <name>@<version>
 ```
 
-## Description
+Install the latest `json11` package.
+```
+soup install json11
+```
 
-Used to install individual packages or all register dependencies for a given recipe.
+Install version `1.0.0` of the `json11` package.
+```
+soup install [email protected]
+```

Docs/CLI/Publish.md

@@ -1,11 +1,12 @@
-# Install packages
-
-## Synopsis
-
+# Publish
+## Overview
+Pack the current recipe folder and publish its contents to the official feed.
 ```
 soup publish
 ```
 
-## Description
-
-Package up the contents of the current recipe and publish its contents to the official feed.
+## Examples
+Publish the latest version of the package in the current folder.
+```
+soup publish
+```

Managed/Core/Build/BuildEngine.cs

@@ -209,7 +209,7 @@ private async Task CompileModuleAsync(
             // Add all of the direct dependencies as module references
             // and set their version defintions
 
-            // TODO: MSVC requires all transient modules also
+            // TODO: MSVC requires all trasnsitive modules also
             bool isRecursive = _compiler.Name == "MSVC";
             await BuildDependencyModuleReferences(path, binaryDirectory, recipe, modules, defines, isRecursive);
 
@@ -276,7 +276,7 @@ private async Task<bool> CheckCompileSourceAsync(
 
             // Add all of the direct dependencies as module references
             // and set their version defintions
-            // TODO: MSVC requires all transient modules also
+            // TODO: MSVC requires all trasnsitive modules also
             bool isRecursive = _compiler.Name == "MSVC";
             await BuildDependencyModuleReferences(path, binaryDirectory, recipe, modules, defines, isRecursive);
 

Managed/Core/Build/BuildRequiredChecker.cs

@@ -15,7 +15,7 @@ public static bool IsSourceFileOutdated(string rootPath, BuildState buildState,
             var sourceFiles = new List<string>();
             sourceFiles.Add(sourceFile);
 
-            // Copy the dependencies and add all transient dependencies to the collection
+            // Copy the dependencies and add all transitive dependencies to the collection
             var dependencyClosure = new List<string>();
             dependencyClosure.AddRange(dependencies);
             dependencyClosure.Add(sourceFile);

Managed/Core/Package/PackageManager.cs

@@ -93,8 +93,8 @@ public static async Task<List<PackageReference>> BuildRecursiveDependeciesAsync(
                 result.Add(dependency);
                 var dependencyPackagePath = BuildKitchenPackagePath(config, dependency);
                 var dependencyRecipe = await RecipeManager.LoadFromFileAsync(dependencyPackagePath);
-                var transientDependencies = await BuildRecursiveDependeciesAsync(config, dependencyRecipe);
-                result.AddRange(transientDependencies);
+                var transsitiveDependencies = await BuildRecursiveDependeciesAsync(config, dependencyRecipe);
+                result.AddRange(transsitiveDependencies);
             }
 
             return result;

Source/Core/Build/BuildEngine.h

@@ -262,7 +262,7 @@ namespace Soup::Build
 				{
 					linkArguments.TargetType = Soup::LinkTarget::StaticLibrary;
 
-					// Add the library as a link dependency and all transient libraries
+					// Add the library as a link dependency and all transitive libraries
 					result.LinkDependencies = arguments.LinkDependencies;
 					result.LinkDependencies.push_back(linkArguments.RootDirectory + linkArguments.TargetFile);
 					break;