Gary Oberbrunner avatar Gary Oberbrunner committed 3b409fb

Fixed up docs for InstallVersionedLib and SHLIBVERSION.

Comments (0)

Files changed (2)

src/engine/SCons/Tool/__init__.xml

 
 When the &cv-link-SHLIBVERSION; construction variable is defined a versioned
 shared library is created. This modifies the &cv-link-SHLINKFLAGS; as required,
-adds the version number to the library name, and creates the symlinks that 
-are needed. &cv-link-SHLIBVERSION; needs to be of the form X.Y.Z, where X 
+adds the version number to the library name, and creates the symlinks that
+are needed. &cv-link-SHLIBVERSION; needs to be of the form X.Y.Z, where X
 and Y are numbers, and Z is a number but can also contain letters to designate
 alpha, beta, or release candidate patch levels.
 
-This builder may create multiple links to the library. On a POSIX system, 
-for the shared library libbar.so.2.3.1, the links created would be 
-libbar.so, libbar.so.2, and libbar.so.2.3; on a Darwin (OSX) system 
-the library would be libbar.2.3.1.dylib and the link would be 
+This builder may create multiple links to the library. On a POSIX system,
+for the shared library libbar.so.2.3.1, the links created would be
+libbar.so, libbar.so.2, and libbar.so.2.3; on a Darwin (OSX) system
+the library would be libbar.2.3.1.dylib and the link would be
 libbar.dylib.
 
 On Windows systems, specifying
 TODO
 </summary>
 </cvar>
+
+<cvar name="SHLIBVERSION">
+<summary>
+When this construction variable is defined, a versioned shared library
+is created. This modifies the &cv-link-SHLINKFLAGS; as required, adds
+the version number to the library name, and creates the symlinks that
+are needed. &cv-link-SHLIBVERSION; needs to be of the form X.Y.Z,
+where X and Y are numbers, and Z is a number but can also contain
+letters to designate alpha, beta, or release candidate patch levels.
+</summary>
+</cvar>

src/engine/SCons/Tool/install.xml

 The names of the specified source files or directories
 remain the same within the destination directory. The
 sources may be given as a string or as a node returned by
-a builder. 
+a builder.
 
 <example>
 env.Install('/usr/local/bin', source = ['foo', 'bar'])
 and
 source
 arguments list different numbers of files or directories.
+</summary>
+</builder>
 
 <builder name="InstallVersionedLib">
 <summary>
-Installs a versioned shared library. The &cv-link-SHLIBVERSION; 
+Installs a versioned shared library. The &cv-link-SHLIBVERSION;
 construction variable should be defined in the environment
 to confirm the version number in the library name.
 The symlinks appropriate to the architecture will be generated.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.