aboutsummaryrefslogtreecommitdiff
path: root/HACKING
blob: 9adef201c259ab28d2e8ad91bf46596a4c4cc3c7 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
-*- mode: org; coding: utf-8; -*-

#+TITLE: Hacking GNU Guix and Its Incredible Distro

Copyright © 2012, 2013, 2014, 2016, 2017, 2019 Ludovic Courtès <ludo@gnu.org>
Copyright © 2015, 2017 Mathieu Lirzin <mthl@gnu.org>
Copyright © 2017 Leo Famulari <leo@famulari.name>
Copyright © 2017 Arun Isaac <arunisaac@systemreboot.net>

  Copying and distribution of this file, with or without modification,
  are permitted in any medium without royalty provided the copyright
  notice and this notice are preserved.

* Contributing

See the manual for useful hacking information, either by running

  info -f doc/guix.info "Contributing"

or by checking the [[https://guix.gnu.org/manual/devel/en/html_node/Contributing.html][web copy of the manual]].
(equal? (commit-difference commit3 commit2) (list commit3)) ;; COMMIT4 is not an ancestor of COMMIT1 so we should get the ;; empty list. (null? (commit-difference commit1 commit4))))))) (test-assert "commit-difference, fork" (with-temporary-git-repository directory '((add "a.txt" "A") (commit "first commit") (branch "devel") (checkout "devel") (add "devel/1.txt" "1") (commit "first devel commit") (add "devel/2.txt" "2") (commit "second devel commit") (checkout "master") (add "b.txt" "B") (commit "second commit") (add "c.txt" "C") (commit "third commit") (merge "devel" "merge") (add "d.txt" "D") (commit "fourth commit")) (with-repository directory repository (let ((master1 (find-commit repository "first commit")) (master2 (find-commit repository "second commit")) (master3 (find-commit repository "third commit")) (master4 (find-commit repository "fourth commit")) (devel1 (find-commit repository "first devel")) (devel2 (find-commit repository "second devel")) (merge (find-commit repository "merge"))) (and (equal? (commit-difference master4 merge) (list master4)) (lset= eq? (commit-difference master3 master1) (list master3 master2)) (lset= eq? (commit-difference devel2 master1) (list devel2 devel1)) ;; The merge occurred between MASTER2 and MASTER4 so here we ;; expect to see all the commits from the "devel" branch in ;; addition to those on "master". (lset= eq? (commit-difference master4 master2) (list master4 merge master3 devel1 devel2))))))) (test-assert "commit-difference, excluded commits" (with-temporary-git-repository directory '((add "a.txt" "A") (commit "first commit") (add "b.txt" "B") (commit "second commit") (add "c.txt" "C") (commit "third commit") (add "d.txt" "D") (commit "fourth commit") (add "e.txt" "E") (commit "fifth commit")) (with-repository directory repository (let ((commit1 (find-commit repository "first")) (commit2 (find-commit repository "second")) (commit3 (find-commit repository "third")) (commit4 (find-commit repository "fourth")) (commit5 (find-commit repository "fifth"))) (and (lset= eq? (commit-difference commit4 commit1 (list commit2)) (list commit3 commit4)) (lset= eq? (commit-difference commit4 commit1 (list commit3)) (list commit4)) (null? (commit-difference commit4 commit1 (list commit5)))))))) (test-equal "commit-relation" '(self ;master3 master3 ancestor ;master1 master3 descendant ;master3 master1 unrelated ;master2 branch1 unrelated ;branch1 master2 ancestor ;branch1 merge descendant ;merge branch1 ancestor ;master1 merge descendant) ;merge master1 (with-temporary-git-repository directory '((add "a.txt" "A") (commit "first commit") (branch "hack") (checkout "hack") (add "1.txt" "1") (commit "branch commit") (checkout "master") (add "b.txt" "B") (commit "second commit") (add "c.txt" "C") (commit "third commit") (merge "hack" "merge")) (with-repository directory repository (let ((master1 (find-commit repository "first")) (master2 (find-commit repository "second")) (master3 (find-commit repository "third")) (branch1 (find-commit repository "branch")) (merge (find-commit repository "merge"))) (list (commit-relation master3 master3) (commit-relation master1 master3) (commit-relation master3 master1) (commit-relation master2 branch1) (commit-relation branch1 master2) (commit-relation branch1 merge) (commit-relation merge branch1) (commit-relation master1 merge) (commit-relation merge master1)))))) (test-equal "commit-descendant?" '((master3 master3 => #t) (master1 master3 => #f) (master3 master1 => #t) (master2 branch1 => #f) (master2 branch1 master1 => #t) (branch1 master2 => #f) (branch1 merge => #f) (merge branch1 => #t) (master1 merge => #f) (merge master1 => #t)) (with-temporary-git-repository directory '((add "a.txt" "A") (commit "first commit") (branch "hack") (checkout "hack") (add "1.txt" "1") (commit "branch commit") (checkout "master") (add "b.txt" "B") (commit "second commit") (add "c.txt" "C") (commit "third commit") (merge "hack" "merge")) (with-repository directory repository (let ((master1 (find-commit repository "first")) (master2 (find-commit repository "second")) (master3 (find-commit repository "third")) (branch1 (find-commit repository "branch")) (merge (find-commit repository "merge"))) (letrec-syntax ((verify (syntax-rules () ((_) '()) ((_ (new old ...) rest ...) (cons `(new old ... => ,(commit-descendant? new (list old ...))) (verify rest ...)))))) (verify (master3 master3) (master1 master3) (master3 master1) (master2 branch1) (master2 branch1 master1) (branch1 master2) (branch1 merge) (merge branch1) (master1 merge) (merge master1))))))) (test-equal "remote-refs" '("refs/heads/develop" "refs/heads/master" "refs/tags/v1.0" "refs/tags/v1.1") (with-temporary-git-repository directory '((add "a.txt" "A") (commit "First commit") (tag "v1.0" "release-1.0") (branch "develop") (checkout "develop") (add "b.txt" "B") (commit "Second commit") (tag "v1.1" "release-1.1")) (remote-refs directory))) (test-equal "remote-refs: only tags" '("refs/tags/v1.0" "refs/tags/v1.1") (with-temporary-git-repository directory '((add "a.txt" "A") (commit "First commit") (tag "v1.0" "Release 1.0") (add "b.txt" "B") (commit "Second commit") (tag "v1.1" "Release 1.1")) (remote-refs directory #:tags? #t))) (test-assert "update-cached-checkout, tag" (call-with-temporary-directory (lambda (cache) (with-temporary-git-repository directory '((add "a.txt" "A") (commit "First commit") (tag "v1.0" "release-1.0") (branch "develop") (checkout "develop") (add "b.txt" "B") (commit "Second commit") (tag "v1.1" "release-1.1")) (let ((directory commit relation (update-cached-checkout directory #:ref '(tag . "v1.1") #:cache-directory cache)) (head (let* ((pipe (open-pipe* OPEN_READ (git-command) "-C" directory "rev-parse" "HEAD")) (str (get-string-all pipe))) (close-pipe pipe) (string-trim-right str)))) ;; COMMIT should be the ID of the commit object, not that of the tag. (string=? commit head)))))) (test-assert "update-cached-checkout, untracked files removed" (call-with-temporary-directory (lambda (cache) (with-temporary-git-repository directory '((add "a.txt" "A") (add ".gitignore" ".~\n") (commit "First commit")) (let ((directory commit relation (update-cached-checkout directory #:ref '() #:cache-directory cache))) (close-port (open-output-file (in-vicinity cache "stale-untracked-file"))) (let ((directory2 commit2 relation2 (update-cached-checkout directory #:ref '() #:cache-directory cache))) (not (file-exists? (in-vicinity cache "stale-untracked-file"))))))))) (test-end "git")