Official NixOS Wiki

Git: Difference between revisions

← Older edit
Phobos (talk | contribs)
121 edits
VisualWikitext
H7x4 (talk | contribs)
20 edits
m Undo revision 17370 by H7x4 (talk), didn't read close enough that this was homemanager config
Tag: Undo
Phobos (talk | contribs)
121 edits
mNo edit summary
 
(11 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[https://en.wikipedia.org/wiki/Git_(software) Git] is the version control system (VCS) designed and developed by Linus Torvalds, the creator of the Linux kernel. Git is used to maintain NixOS packages, as well as many other projects, including sources for the Linux kernel.  
[https://en.wikipedia.org/wiki/Git_(software) Git] is the version control system (VCS) developed by Junio C Hamano and designed by Linus Torvalds (Creator of the Linux kernel). Git is used to maintain NixOS packages, as well as many other projects, including sources for the Linux kernel.  


== Installation ==
== Installing and configuring Git ==


Install the <code>git</code> package.  
On NixOS, Git can be installed and configured at either the system level or the user level with [[Home Manager]].


=== Additional features ===
=== System-wide installation ===


Install <code>tk</code> to use the git gui:
Git can be installed system-wide either by adding it to the list of system environment packages:
 
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
  environment.systemPackages = with pkgs; [
    git
  ];
</nowiki>}}
 
Or by enabling the NixOS Git module:
 
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
  programs.git.enable = true;
</nowiki>}}


<syntaxhighlight lang=console>
Additional Git module configuration options can be found at {{nixos:option|programs.git}}.
$ git citool
</syntaxhighlight>


Or you may wish to install the <code>gitFull</code> package, which includes <code>git gui</code>, <code>gitk</code>, etc.
{{note|Configuration options provided by this module are applied at the system level and therefore apply to all users on the system.}}


== Configuration ==
=== User-level configuration with Home Manager ===


Git can be configured using [[Home Manager]]:
Git can be configured using [[Home Manager]]:
Line 22: Line 32:
   programs.git = {
   programs.git = {
     enable = true;
     enable = true;
     userName = "John Doe";
     settings.user = {
    userEmail = "johndoe@example.com";
        name = "John Doe";
        email = "johndoe@example.com";
    };
   };
   };
</syntaxhighlight>
</syntaxhighlight>
Line 32: Line 44:
   programs.git = {
   programs.git = {
     enable = true;
     enable = true;
     aliases = {
     settings.alias = {
       ci = "commit";
       ci = "commit";
       co = "checkout";
       co = "checkout";
Line 50: Line 62:
Configure git-credential-helper with libsecret:
Configure git-credential-helper with libsecret:


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">{ pkgs, ... }:
{ pkgs, ... }:


{
{
   programs.git = {
   programs.git = {
     enable = true;
     enable = true;
     extraConfig = {
     package = pkgs.git.override { withLibsecret = true; };
      credential.helper = "${
    settings = {
          pkgs.git.override { withLibsecret = true; }
      credential.helper = "libsecret";
        }/bin/git-credential-libsecret";
     };
     };
   };
   };
}
}</syntaxhighlight>
</syntaxhighlight>


For example to add additional configuration you can specify options in an attribute set, so to add something like this:
To add additional configuration you can specify options in an attribute set, so to add something like this:


<syntaxhighlight lang="ini">
<syntaxhighlight lang="ini">
Line 72: Line 81:
</syntaxhighlight>
</syntaxhighlight>


To your <code>~/.config/git/config</code>, you can add the below to <code>extraConfig</code>
To your <code>~/.config/git/config</code>, you can add the below to <code>settings</code>


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
Line 80: Line 89:
   programs.git = {
   programs.git = {
     enable = true;
     enable = true;
     extraConfig = {
     settings = {
       push = { autoSetupRemote = true; };
       push = { autoSetupRemote = true; };
     };
     };
Line 87: Line 96:
</syntaxhighlight>
</syntaxhighlight>


== Management of the <code>nixpkgs</code> git repository ==
==== Using your public SSH key as a signing key ====
 
To configure git to automatically sign your commits using your public SSH key like so:
 
<syntaxhighlight lang="nix">
{
  programs.git = {
    enable = true;
    signing = {
      key = "ssh-ed25519 AAAAAAAAAAAA...AA username@hostname";
      signByDefault = true;
    };
    settings = {
      gpg = {
        format = "ssh";
      };
    };
  };
}
</syntaxhighlight>
 
However, note that this will also require Home Manager to manage your SSH configuration:
 
<syntaxhighlight lang="nix">{   
  programs.ssh = {
    enable = true;
    addKeysToAgent = "yes";
  };
}</syntaxhighlight>
 
=== Enabling Git UI ===
 
Install <code>tk</code> to use the git gui:
 
<syntaxhighlight lang=console>
$ git citool
</syntaxhighlight>
 
Or you may wish to install the <code>gitFull</code> package, which includes <code>git gui</code>, <code>gitk</code>, etc. This can be installed either through system environment packages or by setting the package module option:


<code>nixpkgs</code> has become a git repository of quite substantial size with > 160 000 commits (as of early 2019). This brings many unoptimized tools to their limits, leading to long waiting times on certain operations. Here we’ll collect useful info on how to manage that.
<syntaxhighlight lang="nix">
  programs.git = {
    enable = true;
    package = pkgs.gitFull;
  };
</syntaxhighlight>


=== git ===
== Management of the <code>nixpkgs</code> git repository ==


git itself might not perform as usual with the default settings
<code>nixpkgs</code> has become a git repository of quite substantial size with > 889 000 commits (as of late 2025). This brings many unoptimized tools to their limits, leading to long waiting times on certain operations. Here we’ll collect useful info on how to manage that.


==== <code>git-gc</code> ====
=== Garbage collecting ===


Normal <code>git gc</code> should work as usual, but you should force a full garbage collect every half a year or so. <code>git gc --aggressive</code> is the command for that. For the author it did not work on the first try, since their laptop’s memory was too small and it went out of memory. According to [https://stackoverflow.com/a/4829883/1382925|this StackOverflow] answer it suffices to set some local repository config variables.
Normal <code>git gc</code> should work as usual, but you should force a full garbage collect every half a year or so. <code>git gc --aggressive</code> is the command for that. For the author it did not work on the first try, since their laptop’s memory was too small and it went out of memory. According to [https://stackoverflow.com/a/4829883/1382925|this StackOverflow] answer it suffices to set some local repository config variables.
Line 179: Line 231:
== Bisecting Nix regressions ==
== Bisecting Nix regressions ==


see [[bisecting]]
{{main|bisecting}}


[[Category:Applications]]
[[Category:Applications]]
[[Category:CLI Applications]]
[[Category:Version control]]
[[Category:Version control]]
Retrieved from "https://wiki.nixos.org/wiki/Git"