From d0e3d353065fbdafc64333e7007fae8215ca22d2 Mon Sep 17 00:00:00 2001 From: clojure-build Date: Wed, 1 Jan 2025 16:56:53 +0000 Subject: [PATCH] Autodoc commit --- api-index.html | 8 +++---- index.html | 57 ++++++++++++++++++++++++++------------------------ 2 files changed, 34 insertions(+), 31 deletions(-) diff --git a/api-index.html b/api-index.html index b496c29..cb887a7 100644 --- a/api-index.html +++ b/api-index.html @@ -1,7 +1,7 @@ - Index - tools.deps 0.21.1457-SNAPSHOT API documentation + Index - tools.deps 0.21.1468-SNAPSHOT API documentation @@ -25,7 +25,7 @@

tools.deps A
- tools.deps 0.21.1457-SNAPSHOT API
+ tools.deps 0.21.1468-SNAPSHOT API
  • Overview
  • API Index
    • @@ -41,7 +41,7 @@

    tools.deps A
    -

    Index of Public Functions and Variables - tools.deps 0.21.1457-SNAPSHOT (in development)

    +

    Index of Public Functions and Variables - tools.deps 0.21.1468-SNAPSHOT (in development)

    This page has an alphabetical index of all the documented functions and variables in tools.deps. @@ -217,7 +217,7 @@

    S

    T

      ::threads                    spec          clojure.tools.deps.specs pos-int?.
- tool                         function      clojure.tools.deps Transform project edn for tool by applying tool ar...
+ tool                         function      clojure.tools.deps Replaces project-edn :deps and :paths with tool :d...
  ::tool-args                  spec          clojure.tools.deps.specs (keys :opt-un [:clojure.tools.deps.specs/rep...
  ::trace                      spec          clojure.tools.deps.specs boolean?.
  trace->tree                  function      clojure.tools.deps.tree Convert a deps trace data structure into a de...
diff --git a/index.html b/index.html
index 4f83d23..69b1130 100644
--- a/index.html
+++ b/index.html
@@ -1,7 +1,7 @@
 
   
     
-    clojure.tools.deps - tools.deps 0.21.1457-SNAPSHOT API documentation
+    clojure.tools.deps - tools.deps 0.21.1468-SNAPSHOT API documentation
     
     
     
@@ -25,7 +25,7 @@ 
    tools.deps A
       
    
 
    
   
    
-    tools.deps 0.21.1457-SNAPSHOT API
    
+    tools.deps 0.21.1468-SNAPSHOT API
    
     
    
 
    
                 
    API for clojure.tools.deps
-  - tools.deps 0.21.1457-SNAPSHOT (in development)
+  - tools.deps 0.21.1468-SNAPSHOT (in development)
   
    
 
 
    Full namespace name: clojure.tools.deps
@@ -297,7 +297,7 @@ 
    calc-basis
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -310,13 +310,13 @@ 
    combine-aliases
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
     
    create-basis
    
     function
    
-    
    Usage: (create-basis {:keys [dir root user project extra aliases], :as params})
+    
    Usage: (create-basis {:keys [dir root user project extra aliases args], :as params})
 
    
     
    Create a basis from a set of deps sources and a set of aliases. By default, use
 root, user, and project deps and no argmaps (essentially the same classpath you get by
@@ -325,8 +325,9 @@ 
    create-basis
    
 Each dep source value can be :standard, a string path, a deps edn map, or nil.
 Sources are merged in the order - :root, :user, :project, :extra.
 
-Aliases refer to argmaps in the merged deps that will be supplied to the basis
-subprocesses (tool, resolve-deps, make-classpath-map).
+When resolving deps and forming the classpath, different steps need various
+args. These are pulled from the 'argmap' which is a merged set of args
+selected by the aliases and optionally a map of args.
 
 Options:
   :dir     - directory root path, defaults to current directory
@@ -335,6 +336,7 @@ 
    create-basis
    
   :project - dep source, default = :standard ("deps.edn")
   :extra   - dep source, default = nil
   :aliases - coll of aliases, default = nil
+  :args    - extra map of argmap args, merged after aliases
 
 The following subprocess argmap args can be provided:
   Key                  Subproc             Description
@@ -355,7 +357,7 @@ 
    create-basis
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -368,7 +370,7 @@ 
    create-edn-maps
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -383,7 +385,7 @@ 
    find-edn-maps
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -397,7 +399,7 @@ 
    find-latest-version
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -409,7 +411,7 @@ 
    join-classpath
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -422,7 +424,7 @@ 
    lib-location
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -447,7 +449,7 @@ 
    make-classpath
    
   Ret:  string?
    
     
     Deprecated since tools.deps version 0.9.745
    
-    Source
+    Source
   
    
     
    
     
    
@@ -472,7 +474,7 @@ 
    make-classpath-map
    
   Ret:  map?
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -484,7 +486,7 @@ 
    merge-edns
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -506,7 +508,7 @@ 
    prep-libs!
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -518,7 +520,7 @@ 
    print-tree
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -542,7 +544,7 @@ 
    resolve-added-libs
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -570,7 +572,7 @@ 
    resolve-deps
    
           :clojure.tools.deps.specs/resolved-coord)
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -583,7 +585,7 @@ 
    root-deps
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -596,7 +598,7 @@ 
    slurp-deps
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -604,12 +606,13 @@ 
    tool
    
     function
    
     
    Usage: (tool project-edn tool-args)
 
    
-    
    Transform project edn for tool by applying tool args (keys = :paths, :deps) and
-returning an updated project edn.
    
+    
    Replaces project-edn :deps and :paths with tool :deps and :paths
+and returns a new project-edn map.
+(Also supports :replace-deps and :replace-paths as aliases.)
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -622,7 +625,7 @@ 
    user-deps-path
    
     
    
     
     
-    Source
+    Source