comparison README.txt @ 20:738d84b4de52

start documenting
author Jeff Hammel <jhammel@mozilla.com>
date Wed, 09 Nov 2011 19:55:15 -0800
parents 3fee8ecd1af8
children 81fe0523a078
comparison
equal deleted inserted replaced
19:d69041957c0e 20:738d84b4de52
1 fetch 1 fetch
2 =========== 2 =====
3 3
4 fetch stuff from the interwebs 4 fetch stuff from the interwebs
5
5 6
6 Format 7 Format
7 ------ 8 ------
8 9
9 `fetch` fetches from a manifest of the format 10 `fetch` fetches from a manifest of the format::
10 11
11 [URL] [Destination] [Type] 12 [URL] [Destination] [Type]
13
14 A URL can contain a hash tag (e.g. http://example.com/foo#bar/fleem)
15 which is used to extract the subdirectories from a multi-directory
16 resource.
17
18 The `Type` of the resource is used to dispatch to the included
19 Fetchers that take care of fetching the object.
20
21
22 Fetchers
23 --------
24
25 `fetch` includes several objects for fetching resources::
26
27 file : fetch a single file
28 tar : fetch and extract a tarball
29 hg : checkout a mercurial repository
30 git : checkout a git repository
31
32 The `file` fetcher cannot have a hash tag subpath since it is a single
33 resource.
34
35 Though `fetch` has a set of fetchers included, you can pass an
36 arbitrary list into `fetch.Fetch`'s constructor.
37
38
39 Version Control
40 ---------------
41
42 The `hg` and the `git` fetchers fetch from version control systems and
43 have additional options.
12 44
13 45
14 ---- 46 ----
15 47
16 Jeff Hammel 48 Jeff Hammel