Show More
@@ -1,121 +1,121 b'' | |||
|
1 | 1 | # Copyright 2009-2010 Gregory P. Ward |
|
2 | 2 | # Copyright 2009-2010 Intelerad Medical Systems Incorporated |
|
3 | 3 | # Copyright 2010-2011 Fog Creek Software |
|
4 | 4 | # Copyright 2010-2011 Unity Technologies |
|
5 | 5 | # |
|
6 | 6 | # This software may be used and distributed according to the terms of the |
|
7 | 7 | # GNU General Public License version 2 or any later version. |
|
8 | 8 | |
|
9 | 9 | '''track large binary files |
|
10 | 10 | |
|
11 | 11 | Large binary files tend to be not very compressible, not very |
|
12 | 12 | diffable, and not at all mergeable. Such files are not handled |
|
13 | 13 | efficiently by Mercurial's storage format (revlog), which is based on |
|
14 | 14 | compressed binary deltas; storing large binary files as regular |
|
15 | 15 | Mercurial files wastes bandwidth and disk space and increases |
|
16 | 16 | Mercurial's memory usage. The largefiles extension addresses these |
|
17 | 17 | problems by adding a centralized client-server layer on top of |
|
18 | 18 | Mercurial: largefiles live in a *central store* out on the network |
|
19 | 19 | somewhere, and you only fetch the revisions that you need when you |
|
20 | 20 | need them. |
|
21 | 21 | |
|
22 | 22 | largefiles works by maintaining a "standin file" in .hglf/ for each |
|
23 | 23 | largefile. The standins are small (41 bytes: an SHA-1 hash plus |
|
24 | 24 | newline) and are tracked by Mercurial. Largefile revisions are |
|
25 | 25 | identified by the SHA-1 hash of their contents, which is written to |
|
26 | 26 | the standin. largefiles uses that revision ID to get/put largefile |
|
27 | 27 | revisions from/to the central store. This saves both disk space and |
|
28 | 28 | bandwidth, since you don't need to retrieve all historical revisions |
|
29 | 29 | of large files when you clone or pull. |
|
30 | 30 | |
|
31 | 31 | To start a new repository or add new large binary files, just add |
|
32 | 32 | --large to your :hg:`add` command. For example:: |
|
33 | 33 | |
|
34 | 34 | $ dd if=/dev/urandom of=randomdata count=2000 |
|
35 | 35 | $ hg add --large randomdata |
|
36 | 36 | $ hg commit -m 'add randomdata as a largefile' |
|
37 | 37 | |
|
38 | 38 | When you push a changeset that adds/modifies largefiles to a remote |
|
39 | 39 | repository, its largefile revisions will be uploaded along with it. |
|
40 | 40 | Note that the remote Mercurial must also have the largefiles extension |
|
41 | 41 | enabled for this to work. |
|
42 | 42 | |
|
43 | 43 | When you pull a changeset that affects largefiles from a remote |
|
44 | 44 | repository, the largefiles for the changeset will by default not be |
|
45 | 45 | pulled down. However, when you update to such a revision, any |
|
46 | 46 | largefiles needed by that revision are downloaded and cached (if |
|
47 | 47 | they have never been downloaded before). One way to pull largefiles |
|
48 | 48 | when pulling is thus to use --update, which will update your working |
|
49 | 49 | copy to the latest pulled revision (and thereby downloading any new |
|
50 | 50 | largefiles). |
|
51 | 51 | |
|
52 | 52 | If you want to pull largefiles you don't need for update yet, then |
|
53 | 53 | you can use pull with the `--lfrev` option or the :hg:`lfpull` command. |
|
54 | 54 | |
|
55 |
If you know you are pulling from a non-default location and want |
|
|
56 |
download all the largefiles that correspond |
|
|
55 | If you know you are pulling from a non-default location and want to | |
|
56 | download all the largefiles that correspond to the new changesets at | |
|
57 | 57 | the same time, then you can pull with `--lfrev "pulled()"`. |
|
58 | 58 | |
|
59 | 59 | If you just want to ensure that you will have the largefiles needed to |
|
60 | 60 | merge or rebase with new heads that you are pulling, then you can pull |
|
61 | 61 | with `--lfrev "head(pulled())"` flag to pre-emptively download any largefiles |
|
62 | 62 | that are new in the heads you are pulling. |
|
63 | 63 | |
|
64 | 64 | Keep in mind that network access may now be required to update to |
|
65 | 65 | changesets that you have not previously updated to. The nature of the |
|
66 | 66 | largefiles extension means that updating is no longer guaranteed to |
|
67 | 67 | be a local-only operation. |
|
68 | 68 | |
|
69 | 69 | If you already have large files tracked by Mercurial without the |
|
70 | 70 | largefiles extension, you will need to convert your repository in |
|
71 | 71 | order to benefit from largefiles. This is done with the |
|
72 | 72 | :hg:`lfconvert` command:: |
|
73 | 73 | |
|
74 | 74 | $ hg lfconvert --size 10 oldrepo newrepo |
|
75 | 75 | |
|
76 | 76 | In repositories that already have largefiles in them, any new file |
|
77 | 77 | over 10MB will automatically be added as a largefile. To change this |
|
78 | 78 | threshold, set ``largefiles.minsize`` in your Mercurial config file |
|
79 | 79 | to the minimum size in megabytes to track as a largefile, or use the |
|
80 | 80 | --lfsize option to the add command (also in megabytes):: |
|
81 | 81 | |
|
82 | 82 | [largefiles] |
|
83 | 83 | minsize = 2 |
|
84 | 84 | |
|
85 | 85 | $ hg add --lfsize 2 |
|
86 | 86 | |
|
87 | 87 | The ``largefiles.patterns`` config option allows you to specify a list |
|
88 | 88 | of filename patterns (see :hg:`help patterns`) that should always be |
|
89 | 89 | tracked as largefiles:: |
|
90 | 90 | |
|
91 | 91 | [largefiles] |
|
92 | 92 | patterns = |
|
93 | 93 | *.jpg |
|
94 | 94 | re:.*\.(png|bmp)$ |
|
95 | 95 | library.zip |
|
96 | 96 | content/audio/* |
|
97 | 97 | |
|
98 | 98 | Files that match one of these patterns will be added as largefiles |
|
99 | 99 | regardless of their size. |
|
100 | 100 | |
|
101 | 101 | The ``largefiles.minsize`` and ``largefiles.patterns`` config options |
|
102 | 102 | will be ignored for any repositories not already containing a |
|
103 | 103 | largefile. To add the first largefile to a repository, you must |
|
104 | 104 | explicitly do so with the --large flag passed to the :hg:`add` |
|
105 | 105 | command. |
|
106 | 106 | ''' |
|
107 | 107 | |
|
108 | 108 | from mercurial import commands |
|
109 | 109 | |
|
110 | 110 | import lfcommands |
|
111 | 111 | import reposetup |
|
112 | 112 | import uisetup |
|
113 | 113 | |
|
114 | 114 | testedwith = 'internal' |
|
115 | 115 | |
|
116 | 116 | reposetup = reposetup.reposetup |
|
117 | 117 | uisetup = uisetup.uisetup |
|
118 | 118 | |
|
119 | 119 | commands.norepo += " lfconvert" |
|
120 | 120 | |
|
121 | 121 | cmdtable = lfcommands.cmdtable |
General Comments 0
You need to be logged in to leave comments.
Login now