commit 1a21a6dd6de115f2de954e005a5ceef57dbfc943 from: Stefan Sperling date: Sun Sep 12 16:27:47 2021 UTC add got.conf(5) manual page to the website; reminder by lemmontree on IRC commit - 7945ca33f91319207b2f0bddfcb5f206ec1bc14b commit + 1a21a6dd6de115f2de954e005a5ceef57dbfc943 blob - /dev/null blob + bee95739eff634d4a5afa0f356db30c6d3f314cb (mode 644) --- /dev/null +++ got.conf.5.html @@ -0,0 +1,285 @@ + + + + + + + + GOT.CONF(5) + + + + + + + + +
GOT.CONF(5)File Formats ManualGOT.CONF(5)
+
+
+

+

got.conf — Game of + Trees configuration file

+
+
+

+

got.conf is the run-time configuration + file for got(1).

+

got.conf may be present in the root + directory of a Git repository for repository-wide settings, or in the + .got meta-data directory of a work tree to override + repository-wide settings for got(1) commands executed + within this work tree.

+

The file format is line-based, with one configuration directive + per line. Any lines beginning with a ‘#’ are treated as + comments and ignored.

+

The available configuration directives are as follows:

+
+
+ “Real Name <email address>”
+
Configure the author's name and email address for got + commit and got import when operating on + this repository. Author information specified here overrides the + GOT_AUTHOR environment variable. +

Because git(1) may fail to parse commits + without an email address in author data, got(1) + attempts to reject author information with a missing email address.

+
+
+ name {...}
+
Define a remote repository. The specified name can + be used to refer to the remote repository on the command line of + got fetch and got send. +

Information about this repository is declared in a block of + options enclosed in curly brackets:

+
+
+ hostname
+
Defines the hostname to use for contacting the remote repository's + server.
+
+ path
+
Defines the path to the repository on the remote repository's + server.
+
+ scheme
+
Defines the protocol to use for communicating with the remote + repository's server. +

The following protocol schemes are supported:

+
+
git
+
The Git protocol as implemented by the + git-daemon(1) server. Use of this protocol is + discouraged since it supports neither authentication nor + encryption.
+
git+ssh
+
The Git protocol wrapped in an authenticated and encrypted + ssh(1) tunnel. With this protocol the hostname + may contain an embedded username for ssh(1) to + use: + user@hostname
+
ssh
+
Short alias for git+ssh.
+
+
+
+ port
+
Defines the port to use for connecting to the remote repository's + server. The port can be specified by number or + name. The port name to number mappings are found in the file + /etc/services; see + services(5) for details. If not specified, the + default port of the specified protocol will be + used.
+
+ {branch ...}
+
Specify one or more branches which got fetch + and got send should fetch from and send to the + remote repository by default. The list of branches specified here can + be overridden at the got fetch and + got send command lines with the + -b option.
+
+ yes | no
+
This option controls whether got fetch will + fetch all branches from the remote repository by default. If enabled, + this behaviour can be overridden at the got + fetch command line with the -b option, + and any branch configuration settings for this + remote repository will be ignored.
+
+ {reference ...}
+
Specify one or more arbitrary references which got + fetch should fetch by default, in addition to the branches and + tags that will be fetched. The list of references specified here can + be overridden at the got fetch command line + with the -R option. got + fetch will refuse to fetch references from the remote + repository's “refs/remotes/” or + “refs/got/” namespace. In any case, references in the + “refs/tags/” namespace will always be fetched and mapped + directly to local references in the same namespace.
+
+ yes | no
+
This option controls the behaviour of got + fetch when updating references. + Maintaining + custom changes in a mirror repository is therefore discouraged. +

If this option is not specified or set to + no, got fetch will map + references of the remote repository into the local repository's + “refs/remotes/” namespace.

+

If this option is set to yes, all + branches in the “refs/heads/” namespace will be + updated directly to match the corresponding branches in the remote + repository.

+
+
+ {...}
+
An optional fetch block may contain any of the + following configuration settings for use by got + fetch, overriding corresponding settings in the containing + remote name {...} block. + +
+
+ {...}
+
An optional send block may contain any of the + following configuration settings for use by got + send, overriding corresponding settings in the containing + remote name {...} block. + +
+
+
+
+
+
+

+

Configure author information:

+
+
author "Flan Hacker <flan_hacker@openbsd.org>"
+
+

Remote repository specification for the Game of Trees + repository:

+
+
remote "origin" {
+	server git.gameoftrees.org
+	protocol git
+	repository got
+	branch { "main" }
+}
+
+

Mirror the OpenBSD src repository from + Github:

+
+
remote "origin" {
+	repository "openbsd/src"
+	server git@github.com
+	protocol git+ssh
+	mirror-references yes
+}
+
+

Fetch changes via the Git protocol and send changes via the SSH + protocol:

+
+
remote "origin" {
+	repository my_repo
+	server git.example.com
+	protocol git
+	send {
+		server git@git.example.com
+		protocol ssh
+	}
+}
+
+
+
+

+
+
got.conf
+
If present, got.conf located in the root directory + of a Git repository supersedes any relevant settings in Git's + config file. +

+
+
.got/got.conf
+
If present, got.conf located in the + .got meta-data directory of a + got(1) work tree supersedes any relevant settings in the + repository's got.conf configuration file and Git's + config file.
+
+
+
+

+

got(1), git-repository(5), + got-worktree(5)

+
+
+

+

got.conf offers no way to configure the + editor spawned by got commit, got + histedit, got import, or got + tag. This is deliberate and prevents potential arbitrary command + execution as another user when repositories or work trees are shared between + users. Users should set their VISUAL or + EDITOR environment variables instead.

+
+
+ + + + + +
September 12, 2021OpenBSD 7.0
+ + blob - 1b0b3bb94870df57945da272454653d63f4f1e75 blob + 2324f8a5f5cb036b699fb0ece288febfc6dd11b1 --- manual.html +++ manual.html @@ -19,6 +19,7 @@ Manual pages installed by the got package:
  • got — Game of Trees
  • gotadmin — Game of Trees repository administration
  • tog — Git repository browser +
  • got.conf — Game of Trees configuration file
  • got-worktree — Got work tree format
  • git-repository — Git repository format blob - 9736b245e1734f4b365fe2426b8119babcbeafed blob + d863c1e11126f6c78471c762b797a1000a8e8035 --- sync-man.sh +++ sync-man.sh @@ -1,6 +1,6 @@ #!/bin/sh -for f in got.1 got-worktree.5 git-repository.5; do +for f in got.1 got-worktree.5 git-repository.5 got.conf.5; do mandoc -T html $HOME/src/got/got/$f > ./${f}.html done mandoc -T html $HOME/src/got/gotadmin/gotadmin.1 > ./gotadmin.1.html