├── .dir-locals.el
├── .gitignore
├── COPYING
├── README.md
├── README.org
├── TODO.org
└── magit-lfs.el
/.dir-locals.el:
--------------------------------------------------------------------------------
1 | ((emacs-lisp-mode
2 | . ((eval
3 | . (add-to-list 'load-path default-directory)))))
4 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Cask files
2 | .cask/
3 |
4 | # EMACS files
5 | *.elc
6 | *~
--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | # Magit LFS
4 |
5 | [Git LFS](https://git-lfs.github.com/) for [Magit](https://github.com/magit/magit), glorious Git client for Emacs!
6 |
7 | 1. [Installation](#org8e78023)
8 | 2. [Magit Binding](#orgb5694bc)
9 | 1. [Breaking changes](#org82fd3a2)
10 | 3. [Todo List](#org34096ab)
11 |
12 |
13 |
14 |
15 | ## Installation
16 |
17 | 1. In your emacs setting file, initialize [melpa](https://github.com/melpa/melpa) package.
18 | 2. Follows instruction for your package managing method.
19 | - For `package.el`
20 | 1. Install magit and magit-lfs via `package-install` command.
21 | 2. Write following codes to your emacs setting file. (usually `.emacs` or `.emacs.d/init.el`)
22 |
23 | (require 'package)
24 |
25 | ;; package repository settings
26 |
27 | (package-initialize)
28 |
29 | ;; Settings ...
30 |
31 | (require 'magit)
32 |
33 | ;; Settings ...
34 |
35 | (require 'magit-lfs)
36 |
37 | - For `use-package.el`
38 | 1. Install magit and load it.
39 | 2. Write following codes to your emacs setting file.
40 |
41 | (require 'package)
42 | (require 'use-package)
43 |
44 | ;; Settings ...
45 |
46 | (package-initialize)
47 |
48 | ;; After load magit
49 |
50 | (use-package magit-lfs
51 | :ensure t
52 | :pin melpa)
53 |
54 | - For `req-package.el`
55 | 1. Write following codes to your emacs settings file.
56 |
57 | (require 'package)
58 |
59 | ;; Settings ...
60 |
61 | (package-initialize)
62 |
63 | ;; Settings ...
64 |
65 | (require 'req-package)
66 |
67 | ;; Settings ...
68 |
69 | (req-package magit-lfs
70 | :loader :elpa
71 | :pin melpa
72 | :require (magit))
73 |
74 |
75 |
76 |
77 | ## Magit Binding
78 |
79 | - `:`
80 | Initial commands for magit-lfs.
81 | - `f`
82 | git lfs fetch
83 | - `F`
84 | git lfs Pull
85 | - `i`
86 | git lfs install
87 | - `P`
88 | git lfs push
89 | - `U`
90 | git lfs update
91 | - `!`
92 | git lfs fsck
93 |
94 |
95 |
96 |
97 | ### Breaking changes
98 |
99 | The bindings for the initial popup were `&` and `@`, but they conflicted with bindings for other magit bindings, so I changed the binding to `:`
100 |
101 |
102 |
103 |
104 | ## Todo List
105 |
106 | - Core functionality [2/3]
107 | - [X] Make magit popup
108 | - [ ] Checking git lfs status
109 | - [X] Connect to git lfs
110 | - Command specific functionality [6/12]
111 | - [ ] checkout
112 | - [X] fetch
113 | - [X] fsck
114 | - [X] install
115 | - [ ] logs
116 | - [ ] ls-files
117 | - [X] pull
118 | - [X] push
119 | - [ ] status
120 | - [ ] track
121 | - [ ] untrack
122 | - [X] update
123 |
124 |
--------------------------------------------------------------------------------
/README.org:
--------------------------------------------------------------------------------
1 | #+TITLE: Magit LFS
2 | #+AUTHOR: Junyoung Clare Jang
3 | #+EMAIL: jjc9310@gmail.com
4 | #+CATEGORY: magit git-lfs version-manager
5 | #+OPTIONS: toc:nil
6 |
7 | * Magit LFS
8 |
9 | [[https://git-lfs.github.com/][Git LFS]] for [[https://github.com/magit/magit][Magit]], glorious Git client for Emacs!
10 |
11 | #+TOC: headlines local
12 |
13 | ** Installation
14 | 1. In your emacs setting file, initialize [[https://github.com/melpa/melpa][melpa]] package.
15 | 2. Follows instruction for your package managing method.
16 |
17 | - For ~package.el~
18 | 1. Install magit and magit-lfs via ~package-install~ command.
19 | 2. Write following codes to your emacs setting file. (usually ~.emacs~ or ~.emacs.d/init.el~)
20 |
21 | #+BEGIN_SRC elisp
22 | (require 'package)
23 |
24 | ;; package repository settings
25 |
26 | (package-initialize)
27 |
28 | ;; Settings ...
29 |
30 | (require 'magit)
31 |
32 | ;; Settings ...
33 |
34 | (require 'magit-lfs)
35 | #+END_SRC
36 |
37 | - For ~use-package.el~
38 |
39 | 1. Install magit and load it.
40 | 2. Write following codes to your emacs setting file.
41 |
42 | #+BEGIN_SRC elisp
43 | (require 'package)
44 | (require 'use-package)
45 |
46 | ;; Settings ...
47 |
48 | (package-initialize)
49 |
50 | ;; After load magit
51 |
52 | (use-package magit-lfs
53 | :ensure t
54 | :pin melpa)
55 | #+END_SRC
56 |
57 | - For ~req-package.el~
58 |
59 | 1. Write following codes to your emacs settings file.
60 |
61 | #+BEGIN_SRC elisp
62 | (require 'package)
63 |
64 | ;; Settings ...
65 |
66 | (package-initialize)
67 |
68 | ;; Settings ...
69 |
70 | (require 'req-package)
71 |
72 | ;; Settings ...
73 |
74 | (req-package magit-lfs
75 | :loader :elpa
76 | :pin melpa
77 | :require (magit))
78 | #+END_SRC
79 |
80 | ** Magit Binding
81 | - ~:~
82 | Initial commands for magit-lfs.
83 | - ~f~
84 | git lfs fetch
85 | - ~F~
86 | git lfs Pull
87 | - ~i~
88 | git lfs install
89 | - ~P~
90 | git lfs push
91 | - ~U~
92 | git lfs update
93 | - ~!~
94 | git lfs fsck
95 |
96 | *** Breaking changes
97 | The bindings for the initial popup were ~&~ and ~@~, but they conflicted with bindings for other magit bindings, so I changed the binding to ~:~
98 |
99 | ** Todo List
100 | - Core functionality [2/3]
101 | - [X] Make magit popup
102 | - [ ] Checking git lfs status
103 | - [X] Connect to git lfs
104 | - Command specific functionality [6/12]
105 | - [ ] checkout
106 | - [X] fetch
107 | - [X] fsck
108 | - [X] install
109 | - [ ] logs
110 | - [ ] ls-files
111 | - [X] pull
112 | - [X] push
113 | - [ ] status
114 | - [ ] track
115 | - [ ] untrack
116 | - [X] update
117 |
--------------------------------------------------------------------------------
/TODO.org:
--------------------------------------------------------------------------------
1 | #+TITLE: Magit LFS TODO
2 | #+AUTHOR: Junyoung Clare Jang
3 | #+EMAIL: jjc9310@gmail.com
4 | #+CATEGORY: magit git-lfs version-manager
5 | #+OPTIONS: toc:nil
6 |
7 | * Magit LFS
8 |
9 | ** TODO For version 0.4.0
10 |
11 | - Add track/untrack listing [0%]
12 | - [ ] listing (new buffer or just in magit?)
13 | - [ ] track
14 | - [ ] untrack
15 | - [ ] .gitattributes file editing
16 |
17 | ** TODO For future version
18 |
19 | - Add status checking [0%]
20 | - [ ] status (new buffer or just in magit?)
21 | - Add lock/unlock listing [0%]
22 | - [ ] listing (new buffer or just in magit?)
23 | - [ ] lock
24 | - [ ] unlock
25 | - Add logs/ls-files [0%]
26 | - [ ] logging buffer
27 | - [ ] logs
28 | - [ ] ls-files
29 | - Add clone command [0%]
30 | - [ ] clone command
31 |
--------------------------------------------------------------------------------
/magit-lfs.el:
--------------------------------------------------------------------------------
1 | ;;; magit-lfs.el --- Magit plugin for Git LFS
2 |
3 | ;; Copyright (C) 2017 Junyoung Clare Jang
4 |
5 | ;; Author: Junyoung/Clare Jang
6 | ;; Maintainer: Junyoung/Clare Jang
7 | ;; Created: 25 Feb 2017
8 | ;; Version: 0.4.1
9 | ;; Package-Requires: ((emacs "24.4") (magit "2.10.3") (dash "2.13.0"))
10 | ;; Keywords: magit git lfs tools vc
11 | ;; URL: https://github.com/ailrun/magit-lfs
12 |
13 | ;; This file is not part of GNU Emacs.
14 |
15 | ;; This program is free software; you can redistribute it and/or modify
16 | ;; it under the terms of the GNU General Public License as published by
17 | ;; the Free Software Foundation; either version 3, or (at your option)
18 | ;; any later version.
19 |
20 | ;; This program is distributed in the hope that it will be useful,
21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 | ;; GNU General Public License for more details.
24 |
25 | ;; You should have received a copy of the GNU General Public License
26 | ;; along with package-stack; see the file COPYING. If not, see
27 | ;; .
28 |
29 | ;;; Commentary:
30 |
31 | ;; The `magit-lfs' is plugin for `magit', most famous Emacs-Git integration.
32 | ;; This plugin is `magit' integrated frontend for Git LFS,
33 | ;; Git Large File System.
34 | ;;
35 | ;; To use this plugin,
36 | ;;
37 | ;; 1. Install git-lfs.
38 | ;;
39 | ;; 2. Use following codes in your Emacs setting.
40 | ;;
41 | ;; - For Vanilla Emacs (After install magit, magit-lfs):
42 | ;;
43 | ;; (require 'magit-lfs)
44 | ;;
45 | ;; - For Emacs with `use-package' (After load magit, dash):
46 | ;;
47 | ;; (use-package magit-lfs
48 | ;; :ensure t
49 | ;; :pin melpa)
50 | ;;
51 | ;; - For Emacs with `req-package' (After install dash):
52 | ;;
53 | ;; (req-package magit-lfs
54 | ;; :loader :elpa
55 | ;; :pin melpa
56 | ;; :require (magit))
57 | ;;
58 | ;; For more detail information, please see README.md
59 |
60 | ;;; Code:
61 |
62 | (require 'dash)
63 | (require 'magit)
64 | (require 'transient)
65 |
66 | (defgroup magit-lfs nil
67 | "Magit powered by git-lfs."
68 | :group 'magit)
69 |
70 | (defcustom magit-lfs-git-lfs-executable "git-lfs"
71 | "Git LFS executable for magit-lfs."
72 | :group 'magit-lfs
73 | :version "0.0.1"
74 | :type 'string)
75 |
76 | (defcustom magit-lfs-git-lfs-command "lfs"
77 | "Git LFS command for magit-lfs."
78 | :group 'magit-lfs
79 | :version "0.0.1"
80 | :type 'string)
81 |
82 | (defcustom magit-lfs-suffix ":"
83 | "Suffix key for magit-lfs in transient popup."
84 | :group 'magit-lfs
85 | :version "0.4.0"
86 | :type 'string)
87 |
88 | (defun magit-lfs-with-lfs (magit-function command &rest args)
89 | "Internal function for magit-lfs to run MAGIT-FUNCTION with COMMAND and ARGS."
90 | (declare (indent 1))
91 | (if (null (executable-find magit-lfs-git-lfs-executable))
92 | (user-error "Git LFS executable %s is not installed; aborting"
93 | magit-lfs-git-lfs-executable)
94 | (apply magit-function magit-lfs-git-lfs-command command args)))
95 |
96 | (transient-define-prefix magit-lfs ()
97 | "Popup console for top-level magit-lfs commands."
98 | :man-page "git-lfs"
99 | ["Actions"
100 | ("f" "fetch, Download file" magit-lfs-fetch)
101 | ("F" "pull, Fetch & checkout files" magit-lfs-pull)
102 | ("i" "install, Install configuration" magit-lfs-install)
103 | ;; ("l" "logs, Show error logs for LFS" magit-lfs-logs)
104 | ("P" "push, Push files to end point" magit-lfs-push)
105 | ("U" "update, Update hook for repo" magit-lfs-update)
106 | ("!" "fsck, Check file" magit-lfs-fsck)])
107 |
108 | (transient-append-suffix 'magit-dispatch '(0 -1 -1)
109 | `(magit-lfs
110 | :key ,magit-lfs-suffix
111 | :description "Magit-LFS"))
112 | (define-key magit-status-mode-map
113 | magit-lfs-suffix #'magit-lfs)
114 |
115 | (transient-define-prefix magit-lfs-fetch ()
116 | ""
117 | :man-page "git-lfs-fetch"
118 | ["Arguments"
119 | ("-p" "Prune old/unreferenced after fetch" "--prune")
120 | ("-a" "Download all objects" "--all")
121 | ("-r" "Download recent changes" "--recent")
122 | ("-I" "Include" "--include=")
123 | ("-X" "Exclude" "--exclude=")]
124 | ["Fetch from"
125 | ("p" magit-lfs-fetch-from-pushremote)
126 | ("u" magit-lfs-fetch-from-upstream)
127 | ("e" "elsewhere" magit-lfs-fetch-elsewhere)]
128 | ["Fetch"
129 | ("o" "another branch" magit-lfs-fetch-branch)])
130 |
131 | (transient-define-prefix magit-lfs-pull ()
132 | ""
133 | :man-page "git-lfs-pull"
134 | ["Arguments"
135 | ("-I" "Include" "--include=")
136 | ("-X" "Exclude" "--exclude=")]
137 | [:description
138 | (lambda ()
139 | (if-let ((branch (magit-get-current-branch)))
140 | (concat
141 | (propertize "Pull into " 'face 'transient-heading)
142 | (propertize branch 'face 'magit-branch-local)
143 | (propertize " from" 'face 'transient-heading))
144 | (propertize "Pull from" 'face 'transient-heading)))
145 | ("p" magit-lfs-pull-from-pushremote)
146 | ("u" magit-lfs-pull-from-upstream)
147 | ("e" "elsewhere" magit-lfs-pull-elsewhere)]
148 | ["Fetch"
149 | ("o" "another branch" magit-lfs-fetch-branch)])
150 |
151 | (transient-define-prefix magit-lfs-install ()
152 | ""
153 | :man-page "git-lfs-install"
154 | ["Arguments"
155 | ("-F" "Set LFS by overwriting values" "--force")
156 | ("-s" "Skips automatic downloading for clone/pull" "--skip-smudge")]
157 | ["Set in"
158 | ("l" "Local repository's config" magit-lfs-install-to-local-config)
159 | ("g" "Global config" magit-lfs-install-to-global-config)])
160 |
161 | ;; (transient-define-prefix magit-lfs-logs ()
162 | ;; ""
163 | ;; :man-page "git-lfs-logs"
164 | ;; :actions '("Actions"
165 | ;; (?b "Triggers a dummy exception" magit-lfs-logs-boomtown)
166 | ;; (?c "Clear error logs" magit-lfs-logs-clear)
167 | ;; (?s "Show logs" magit-lfs-logs-show)))
168 |
169 | (transient-define-prefix magit-lfs-push ()
170 | ""
171 | :man-page "git-lfs-push"
172 | ["Arguments"
173 | ("-d" "Dry run" "--dry-run")
174 | ("-a" "Push all objects to remote" "--all")]
175 | [:description
176 | (lambda ()
177 | (when-let ((branch (magit-get-current-branch)))
178 | (concat (propertize "Push " 'face 'transient-heading)
179 | (propertize branch 'face 'magit-branch-local)
180 | (propertize " to" 'face 'transient-heading))))
181 | ("p" magit-lfs-push-current-to-pushremote)
182 | ("u" magit-lfs-push-current-to-upstream)
183 | ("e" "elsewhere" magit-lfs-push-current-to-elsewhere)]
184 | ["Push"
185 | ("o" "another branch" magit-lfs-push-another-branch)])
186 |
187 | (transient-define-prefix magit-lfs-update ()
188 | ""
189 | :man-page "git-lfs-update"
190 | ["Arguments"
191 | ("-f" "Update hook, clobbering existing contents" "--force")]
192 | ["Updates"
193 | ("h" "hooks" magit-lfs-update-hooks)])
194 |
195 |
196 | (defun magit-lfs-fsck ()
197 | "Magit binding for git lfs fsck."
198 | (interactive)
199 | (magit-lfs-with-lfs 'magit-run-git-async "fsck"))
200 |
201 |
202 | (defun magit-lfs-fetch-arguments nil
203 | ""
204 | (transient-args 'magit-lfs-fetch))
205 |
206 | (defun magit-lfs-git-lfs-fetch (remote args)
207 | "Internal function for git lfs fetch REMOTE with ARGS."
208 | (run-hooks 'magit-credential-hook)
209 | (magit-lfs-with-lfs 'magit-run-git-async "fetch" remote args))
210 |
211 | (transient-define-suffix magit-lfs-fetch-from-pushremote (args)
212 | "Magit binding for git lfs fetch push-remote of the current branch with ARGS."
213 | :description 'magit-fetch--pushremote-description
214 | (interactive (list (magit-lfs-fetch-arguments)))
215 | (let ((remote (magit-get-push-remote)))
216 | (when (or current-prefix-arg
217 | (not (member remote (magit-list-remotes))))
218 | (let ((var (magit--push-remote-variable)))
219 | (setq remote
220 | (magit-read-remote (format "Set %s and fetch from there" var)))
221 | (magit-set remote var)))
222 | (magit-lfs-git-lfs-fetch remote args)))
223 |
224 | (transient-define-suffix magit-lfs-fetch-from-upstream (upstream args)
225 | "Magit binding for git lfs fetch UPSTREAM with ARGS."
226 | :if (lambda () (magit-get-current-remote t))
227 | :description (lambda () (magit-get-current-remote t))
228 | (interactive (list (magit-get-current-remote t)
229 | (magit-lfs-fetch-arguments)))
230 | (unless upstream
231 | (error "The \"current\" upstream could not be determined"))
232 | (magit-lfs-git-lfs-fetch upstream args))
233 |
234 | (defun magit-lfs-fetch-elsewhere (remote args)
235 | "Magit binding for git lfs fetch REMOTE with ARGS."
236 | (interactive (list (magit-read-remote "Fetch remote")
237 | (magit-lfs-fetch-arguments)))
238 | (magit-lfs-git-lfs-fetch remote args))
239 |
240 | (defun magit-lfs-fetch-branch (remote branch args)
241 | "Magit binding for git lfs fetch REMOTE/BRANCH with ARGS."
242 | (interactive
243 | (let ((remote (magit-read-remote-or-url "Fetch from remote or url")))
244 | (list remote
245 | (magit-read-remote-branch "Fetch branch" remote)
246 | (magit-lfs-fetch-arguments))))
247 | (magit-lfs-git-lfs-fetch remote (cons branch args)))
248 |
249 |
250 | (defun magit-lfs-install-arguments nil
251 | ""
252 | (transient-args 'magit-lfs-install))
253 |
254 | (defun magit-lfs-git-lfs-install (args)
255 | "Internal function for git lfs install with ARGS."
256 | (magit-lfs-with-lfs 'magit-run-git-async "install" args))
257 |
258 | (defun magit-lfs-install-to-local-config (args)
259 | "Magit binding for git lfs install --local with ARGS."
260 | (interactive (list (magit-lfs-install-arguments)))
261 | (magit-lfs-git-lfs-install (cons "--local" args)))
262 |
263 | (defun magit-lfs-install-to-global-config (args)
264 | "Magit binding for git lfs install with ARGS."
265 | (interactive (list (magit-lfs-install-arguments)))
266 | (magit-lfs-git-lfs-install args))
267 |
268 |
269 | ;; (defun magit-lfs-logs-boomtown ()
270 | ;; "Magit binding for git lfs logs --boomtown.")
271 |
272 | ;; (defun magit-lfs-logs-clear ()
273 | ;; "Magit binding for git lfs logs --clear.")
274 |
275 | ;; (defun magit-lfs-logs-show ()
276 | ;; "Magit binding for git lfs logs --show.")
277 |
278 |
279 | ;; (defun magit-lfs-ls-files ()
280 | ;; "Magit binding for git lfs ls-files.")
281 |
282 |
283 | (defun magit-lfs-pull-arguments nil
284 | ""
285 | (transient-args 'magit-lfs-pull))
286 |
287 | (defun magit-lfs-git-lfs-pull (remote branch args)
288 | "Internal function for git lfs pull REMOTE/BRANCH with ARGS."
289 | (run-hooks 'magit-credential-hook)
290 | (magit-lfs-with-lfs 'magit-run-git-with-editor "pull" args remote branch))
291 |
292 | (transient-define-suffix magit-lfs-pull-from-pushremote (args)
293 | "Magit binding for git lfs pull push-remote of the current branch with ARGS."
294 | :if 'magit-get-current-branch
295 | :description 'magit-pull--pushbranch-description
296 | (interactive (list (magit-lfs-pull-arguments)))
297 | (pcase-let ((`(,branch ,remote)
298 | (magit--select-push-remote "pull from there")))
299 | (run-hooks 'magit-credential-hook)
300 | (magit-lfs-git-lfs-pull remote branch args)))
301 |
302 | (transient-define-suffix magit-lfs-pull-from-upstream (args)
303 | "Magit binding for git lfs pull upstream with ARGS."
304 | :if 'magit-get-current-branch
305 | :description 'magit-pull--upstream-description
306 | (interactive (list (magit-lfs-pull-arguments)))
307 | (let* ((branch (or (magit-get-current-branch)
308 | (user-error "No branch is checked out")))
309 | (remote (magit-get "branch" branch "remote"))
310 | (merge (magit-get "branch" branch "merge")))
311 | (when (or current-prefix-arg
312 | (not (or (magit-get-upstream-branch branch)
313 | (magit--unnamed-upstream-p remote merge))))
314 | (magit-set-upstream-branch
315 | branch (magit-read-upstream-branch
316 | branch (format "Set upstream of %s and pull from there" branch)))
317 | (setq remote (magit-get "branch" branch "remote"))
318 | (setq merge (magit-get "branch" branch "merge")))
319 | (run-hooks 'magit-credential-hook)
320 | (magit-lfs-git-lfs-pull remote merge args)))
321 |
322 | (defun magit-lfs-pull-elsewhere (source args)
323 | "Magit binding for git lfs pull SOURCE with ARGS."
324 | (interactive (list (magit-read-remote-branch "Pull" nil nil nil t)
325 | (magit-lfs-pull-arguments)))
326 | (pcase-let ((`(,remote . ,branch)
327 | (magit-get-tracked source)))
328 | (magit-lfs-git-lfs-pull remote branch args)))
329 |
330 |
331 | (defun magit-lfs-push-arguments nil
332 | ""
333 | (transient-args 'magit-lfs-push))
334 |
335 | (defun magit-lfs-git-lfs-push-raw (remote refspec args)
336 | "Internal function for git lfs push REMOTE REFSPEC with ARGS."
337 | (run-hooks 'magit-credential-hook)
338 | (magit-lfs-with-lfs 'magit-run-git-async "push" "-v" args remote refspec))
339 |
340 | (defun magit-lfs-git-lfs-push (branch target args)
341 | "Internal function for git lfs push with ARGS."
342 | (pcase-let ((namespace (if (magit-get-tracked target) "" "refs/heads/"))
343 | (`(,remote . ,target)
344 | (magit-split-branch-name target)))
345 | (magit-lfs-git-lfs-push-raw remote (format "%s:%s%s" branch namespace target) args)))
346 |
347 | (transient-define-suffix magit-lfs-push-current-to-pushremote (args)
348 | "Magit binding for git lfs push current branch to PUSH-REMOTE with ARGS."
349 | :if 'magit-get-current-branch
350 | :description 'magit-push--pushbranch-description
351 | (interactive (list (magit-lfs-push-arguments)))
352 | (pcase-let ((`(,_ ,remote)
353 | (magit--select-push-remote "push there")))
354 | (magit-lfs-git-lfs-push-raw remote "HEAD" args)))
355 |
356 | (transient-define-suffix magit-lfs-push-current-to-upstream (args)
357 | "Magit binding for git lfs push current branch to UPSTREAM with ARGS."
358 | :if 'magit-get-current-branch
359 | :description 'magit-push--upstream-description
360 | (interactive (list (magit-lfs-push-arguments)))
361 | (let* ((branch (or (magit-get-current-branch)
362 | (user-error "No branch is checked out")))
363 | (remote (magit-get "branch" branch "remote"))
364 | (merge (magit-get "branch" branch "merge")))
365 | (when (or current-prefix-arg
366 | (not (or (magit-get-upstream-branch branch)
367 | (magit--unnamed-upstream-p remote merge)
368 | (magit--valid-upstream-p remote merge))))
369 | (let* ((branches (-union (--map (concat it "/" branch)
370 | (magit-list-remotes))
371 | (magit-list-remote-branch-names)))
372 | (upstream (magit-completing-read
373 | (format "Set upstream of %s and push there" branch)
374 | branches nil nil nil 'magit-revision-history
375 | (or (car (member (magit-remote-branch-at-point) branches))
376 | (car (member "origin/master" branches)))))
377 | (upstream (or (magit-get-tracked upstream)
378 | (magit-split-branch-name upstream))))
379 | (setq remote (car upstream))
380 | (setq merge (cdr upstream))
381 | (unless (string-prefix-p "refs/" merge)
382 | ;; User selected a non-existent remote-tracking branch.
383 | ;; It is very likely, but not certain, that this is the
384 | ;; correct thing to do. It is even more likely that it
385 | ;; is what the user wants to happen.
386 | (setq merge (concat "refs/heads/" merge))))
387 | (cl-pushnew "--set-upstream" args :test #'equal))
388 | (run-hooks 'magit-credential-hook)
389 | (magit-lfs-git-lfs-push-raw remote (concat branch ":" merge) args)))
390 |
391 | (defun magit-lfs-push-current-to-elsewhere (target args)
392 | "Magit binding for git lfs push current branch to TARGET with ARGS."
393 | (interactive
394 | (--if-let (magit-get-current-branch)
395 | (list (magit-read-remote-branch (format "Push %s to" it) nil nil it 'confirm)
396 | (magit-lfs-push-arguments))
397 | (user-error "No branch is checked out")))
398 | (magit-lfs-git-lfs-push (magit-get-current-branch) target args))
399 |
400 | (defun magit-lfs-push-another-branch (branch target args)
401 | "Magit binding for git lfs push BRANCH to TARGET with ARGS."
402 | (interactive
403 | (let ((branch (magit-read-local-branch-or-commit "Push")))
404 | (list branch
405 | (magit-read-remote-branch
406 | (format "Push %s to" branch) nil
407 | (if (magit-local-branch-p branch)
408 | (or (magit-get-push-branch branch)
409 | (magit-get-upstream-branch branch))
410 | (and (magit-rev-ancestor-p branch "HEAD")
411 | (or (magit-get-push-branch)
412 | (magit-get-upstream-branch))))
413 | branch 'confirm)
414 | (magit-lfs-push-arguments))))
415 | (magit-lfs-git-lfs-push branch target args))
416 |
417 |
418 | (defun magit-lfs-update-arguments ()
419 | ""
420 | (transient-args 'magit-lfs-update))
421 |
422 | (defun magit-lfs-update-hooks (args)
423 | "Magit binding for git lfs update with ARGS."
424 | (interactive (list (magit-lfs-update-arguments)))
425 | (magit-lfs-with-lfs 'magit-run-git-async "update" args))
426 |
427 |
428 |
429 | (provide 'magit-lfs)
430 |
431 | ;;; magit-lfs.el ends here
432 |
--------------------------------------------------------------------------------