mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

document output as a single line

Browse source
This commit is contained in:
Joey Hess 2025-07-29 14:26:10 -04:00
commit 2a81b26e8e
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/design/generic_p2p_transport.mdwn
View file

@ -20,8 +20,9 @@ connection, the command can exit zero.
To handle incoming connections from peers, `git-annex remotedaemon` To handle incoming connections from peers, `git-annex remotedaemon`
runs `git-annex-p2p-<netname>` with the parameter "socket", followed runs `git-annex-p2p-<netname>` with the parameter "socket", followed
by the P2P address of the local repository. The command by the P2P address of the local repository. The command
should output the path of a unix socket file. When it does, `git-annex should output a single line, the path of a unix socket file.
remotedaemon` will use that socket file to listen for connections from (Any subsequent output is ignored.)
When it does, `git-annex remotedaemon` will use that socket file to listen for connections from
peers, and service them. (The [[P2P_protocol]] is spoken over these peers, and service them. (The [[P2P_protocol]] is spoken over these
connections.) connections.)
@ -32,9 +33,9 @@ to convert the P2P network's own equivilant into a unix socket file.
To configure `git-annex remotedaemon` to listen on a given P2P network, To configure `git-annex remotedaemon` to listen on a given P2P network,
the user runs `git-annex p2p --enable <netname>`. That also the user runs `git-annex p2p --enable <netname>`. That also
runs `git-annex-p2p-<netname>`, this time with the parameter "address". runs `git-annex-p2p-<netname>`, this time with the parameter "address".
That should output the P2P network address that can be used by peers That should output a single line, the P2P network address that can be used
to connect to the repository. It can first do whatever it needs to do to by peers to connect to the repository. It can first do whatever it needs to
set up the P2P networl. do to set up the P2P network.
The program [[git-remote-p2p-annex]] is included in git-annex as a git The program [[git-remote-p2p-annex]] is included in git-annex as a git
remote helper program. git will use that program to handle `pull` and remote helper program. git will use that program to handle `pull` and