Difference between revisions of "Hall D Package Manager"

From GlueXWiki
Jump to: navigation, search
(Using it)
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
This is a set of scripts with a unified user interface for managing Hall-D software. It allows one to build and update Hall-D software from a single directory, and makes it easy to view and modify current package versions. The main idea is to configure builds with a series of simple text files, separating the process of scripting from configuration, and providing templates for future builds. The configuration text files are meant to be general enough so that the user will never need to modify any of the source scripts. Secondly, an effort is made to minimize the number of lines a user will need to modify in order to (re)configure a build; the scripts recognize certain variables, such as [VER] for version number to make this possible. A "master" template is provided along with tools for generating custom templates from it. [https://github.com/JeffersonLab/hdpm Hall D Package Manager] (hdpm) is located at the GitHub along with a thorough README.
+
hdpm is a command line tool for managing Hall-D software. It allows one to build and update Hall-D software from a single directory, and makes it easy to view and modify current package versions. The main idea is to configure package settings with a series of simple files, separating the process of scripting from configuration, and providing a mechanism to save and restore groups of package settings. Default settings are provided which have been tested for compatibility on supported platforms.  
  
==Getting it==
+
==Documentation==
git clone https://github.com/JeffersonLab/hdpm
+
For documentation on how to install and use '''hdpm''', visit its wiki at https://github.com/JeffersonLab/hdpm/wiki.
 
+
==Using it==
+
On '''64-bit Linux''', change to hdpm directory and source the appropriate setup script. This script is for setting up the package manager, not the builds, and needs to be sourced each time a new shell is started.
+
source setup.(c)sh
+
On '''Mac OS X''', change to hdpm directory and do the following:
+
source setup-osx.(c)sh
+
 
+
For help, just type ''''hdpm'''' or ''''hdpm help''''.
+
 
+
The "master" template is automatically copied to the "settings" directory if it does not already exist, and in the absence of preexisting custom templates, "master" will be the only available template.
+
 
+
Select a build template. The "master" template will be selected if no argument is given.
+
hdpm select [template id]
+
 
+
Show the current build settings. Note that these arguments are optional. Column names: "version", "url", "path", "deps", and "cmds".
+
hdpm show [column name] [column spacing]
+
 
+
The current build settings are stored in the "settings" directory; these can be directly modified when the user wants to adjust their settings.
+
 
+
Use the "v-xml" command to change the versions to versions specified in a '''version XML file'''.
+
hdpm v-xml [url or path of xml file]
+
The current settings can be made into a template with the "save" command. Use it with '''jlab''' as the argument to generate and save a base template for building against group installations at JLab (after using "v-xml").
+
hdpm save <new template id>
+
 
+
Checkout, clone, or download selected packages.
+
hdpm fetch [pkgs...]
+
 
+
Build selected packages (fetch if needed). Use with no arguments to build all packages. If a package is already built, the build time, disk use, and timestamp of when the build finished will be displayed.
+
hdpm build [template id]
+
hdpm build [url or path of xml file]
+
hdpm build [pkgs...]
+
 
+
Update selected Git/SVN packages.
+
hdpm update [pkgs...]
+
 
+
Completely remove build products of selected packages.
+
hdpm clean [pkgs...]
+
 
+
Do a clean build of selected packages.
+
hdpm clean-build [pkgs...]
+
 
+
Show usage and description of command.
+
hdpm help <command>
+

Latest revision as of 21:21, 10 March 2017

hdpm is a command line tool for managing Hall-D software. It allows one to build and update Hall-D software from a single directory, and makes it easy to view and modify current package versions. The main idea is to configure package settings with a series of simple files, separating the process of scripting from configuration, and providing a mechanism to save and restore groups of package settings. Default settings are provided which have been tested for compatibility on supported platforms.

Documentation

For documentation on how to install and use hdpm, visit its wiki at https://github.com/JeffersonLab/hdpm/wiki.