source: trunk/abcl/doc/manual/abcl-asdf.tex

Last change on this file was 14932, checked in by Mark Evenson, 7 years ago

doc: further transcriptions of exported symbols

File size: 5.0 KB
Line 
1\paragraph{}
2\label{ABCL-ASDF:*ADDED-TO-CLASSPATH*}
3\index{*ADDED-TO-CLASSPATH*}
4--- Variable: \textbf{*added-to-classpath*} [\textbf{abcl-asdf}] \textit{}
5
6\begin{adjustwidth}{5em}{5em}
7not-documented
8\end{adjustwidth}
9
10\paragraph{}
11\label{ABCL-ASDF:*INHIBIT-ADD-TO-CLASSPATH*}
12\index{*INHIBIT-ADD-TO-CLASSPATH*}
13--- Variable: \textbf{*inhibit-add-to-classpath*} [\textbf{abcl-asdf}] \textit{}
14
15\begin{adjustwidth}{5em}{5em}
16not-documented
17\end{adjustwidth}
18
19\paragraph{}
20\label{ABCL-ASDF:*MAVEN-HTTP-PROXY*}
21\index{*MAVEN-HTTP-PROXY*}
22--- Variable: \textbf{*maven-http-proxy*} [\textbf{abcl-asdf}] \textit{}
23
24\begin{adjustwidth}{5em}{5em}
25A string containing the URI of an http proxy for Maven to use.
26\end{adjustwidth}
27
28\paragraph{}
29\label{ABCL-ASDF:*MAVEN-REMOTE-REPOSITORY*}
30\index{*MAVEN-REMOTE-REPOSITORY*}
31--- Variable: \textbf{*maven-remote-repository*} [\textbf{abcl-asdf}] \textit{}
32
33\begin{adjustwidth}{5em}{5em}
34The remote repository used by the Maven Aether embedder.
35\end{adjustwidth}
36
37\paragraph{}
38\label{ABCL-ASDF:*MAVEN-VERBOSE*}
39\index{*MAVEN-VERBOSE*}
40--- Variable: \textbf{*maven-verbose*} [\textbf{abcl-asdf}] \textit{}
41
42\begin{adjustwidth}{5em}{5em}
43Stream to send output from the Maven Aether subsystem to, or NIL to muffle output
44\end{adjustwidth}
45
46\paragraph{}
47\label{ABCL-ASDF:*MVN-LIBS-DIRECTORY*}
48\index{*MVN-LIBS-DIRECTORY*}
49--- Variable: \textbf{*mvn-libs-directory*} [\textbf{abcl-asdf}] \textit{}
50
51\begin{adjustwidth}{5em}{5em}
52Location of 'maven-core-3.<m>.<p>.jar', 'maven-embedder-3.<m>.<p>.jar' etc.
53\end{adjustwidth}
54
55\paragraph{}
56\label{ABCL-ASDF:ADD-DIRECTORY-JARS-TO-CLASS-PATH}
57\index{ADD-DIRECTORY-JARS-TO-CLASS-PATH}
58--- Function: \textbf{add-directory-jars-to-class-path} [\textbf{abcl-asdf}] \textit{directory recursive-p}
59
60\begin{adjustwidth}{5em}{5em}
61not-documented
62\end{adjustwidth}
63
64\paragraph{}
65\label{ABCL-ASDF:AS-CLASSPATH}
66\index{AS-CLASSPATH}
67--- Function: \textbf{as-classpath} [\textbf{abcl-asdf}] \textit{classpath}
68
69\begin{adjustwidth}{5em}{5em}
70Break apart the JVM CLASSPATH string into a list of its consituents.
71\end{adjustwidth}
72
73\paragraph{}
74\label{ABCL-ASDF:ENSURE-MVN-VERSION}
75\index{ENSURE-MVN-VERSION}
76--- Function: \textbf{ensure-mvn-version} [\textbf{abcl-asdf}] \textit{}
77
78\begin{adjustwidth}{5em}{5em}
79Return t if Maven version is 3.0.3 or greater.
80\end{adjustwidth}
81
82\paragraph{}
83\label{ABCL-ASDF:FIND-MVN}
84\index{FIND-MVN}
85--- Function: \textbf{find-mvn} [\textbf{abcl-asdf}] \textit{}
86
87\begin{adjustwidth}{5em}{5em}
88Attempt to find a suitable Maven ('mvn') executable on the hosting operating system.
89
90Returns the path of the Maven executable or nil if none are found.
91
92Returns the version of Maven found as the second value.
93
94Emits warnings if not able to find a suitable executable.
95\end{adjustwidth}
96
97\paragraph{}
98\label{ABCL-ASDF:INIT}
99\index{INIT}
100--- Function: \textbf{init} [\textbf{abcl-asdf}] \textit{\&optional \&key (force NIL)}
101
102\begin{adjustwidth}{5em}{5em}
103Run the initialization strategy to bootstrap a Maven dependency node.
104
105Set *MVN-LIBS-DIRECTORY* to an explicit value before running this
106function in order to bypass the dynamic introspection of the location
107of the mvn executable with an explicit value.
108\end{adjustwidth}
109
110\paragraph{}
111\label{ABCL-ASDF:MAKE-REMOTE-REPOSITORY}
112\index{MAKE-REMOTE-REPOSITORY}
113--- Function: \textbf{make-remote-repository} [\textbf{abcl-asdf}] \textit{id type url}
114
115\begin{adjustwidth}{5em}{5em}
116not-documented
117\end{adjustwidth}
118
119\paragraph{}
120\label{ABCL-ASDF:NEED-TO-ADD-DIRECTORY-JAR?}
121\index{NEED-TO-ADD-DIRECTORY-JAR?}
122--- Function: \textbf{need-to-add-directory-jar?} [\textbf{abcl-asdf}] \textit{directory recursive-p}
123
124\begin{adjustwidth}{5em}{5em}
125not-documented
126\end{adjustwidth}
127
128\paragraph{}
129\label{ABCL-ASDF:RESOLVE}
130\index{RESOLVE}
131--- Generic Function: \textbf{resolve} [\textbf{abcl-asdf}] \textit{}
132
133\begin{adjustwidth}{5em}{5em}
134Returns a string in JVM CLASSPATH format as entries delimited by classpath separator string.
135\end{adjustwidth}
136
137\paragraph{}
138\label{ABCL-ASDF:RESOLVE-ARTIFACT}
139\index{RESOLVE-ARTIFACT}
140--- Function: \textbf{resolve-artifact} [\textbf{abcl-asdf}] \textit{group-id artifact-id \&key (version LATEST versionp)}
141
142\begin{adjustwidth}{5em}{5em}
143Resolve artifact to location on the local filesystem.
144
145Declared dependencies are not attempted to be located.
146
147If unspecified, the string "LATEST" will be used for the VERSION.
148
149Returns the Maven specific string for the artifact
150\end{adjustwidth}
151
152\paragraph{}
153\label{ABCL-ASDF:RESOLVE-DEPENDENCIES}
154\index{RESOLVE-DEPENDENCIES}
155--- Function: \textbf{resolve-dependencies} [\textbf{abcl-asdf}] \textit{group-id artifact-id \&key (version LATEST versionp) (repository *maven-remote-repository* repository-p)}
156
157\begin{adjustwidth}{5em}{5em}
158Dynamically resolve Maven dependencies for item with GROUP-ID and ARTIFACT-ID
159optionally with a VERSION and a REPOSITORY. 
160
161All recursive dependencies will be visited before resolution is successful.
162
163If unspecified, the string "LATEST" will be used for the VERSION.
164
165Returns a string containing the necessary jvm classpath entries packed
166in Java CLASSPATH representation.
167\end{adjustwidth}
168
Note: See TracBrowser for help on using the repository browser.