annotate README.txt @ 52:c9f2311dedea

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