From 53c439e584eb81b62d49a83a2b29c8745f5656fd Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Sat, 4 Jun 2022 02:28:48 +0530 Subject: socket: Introduce types. will be a universal type to specify IP addresses, ports and Unix sockets across all guix-forge services. * guix/forge/socket.scm: New file. * doc/forge.skb (Reference): Document and . --- doc/forge.skb | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'doc') diff --git a/doc/forge.skb b/doc/forge.skb index 7aa7939..5c46412 100644 --- a/doc/forge.skb +++ b/doc/forge.skb @@ -240,6 +240,17 @@ unused unused, and may be deprecated in the future.])) (record-field "trigger?" [If ,(code [#t]), this job is run on every commit. Else, it must be manually set up to run some other way.])) + (record-documentation "guix/forge/socket.scm" ' + (record-field "ip" + [IP address, either IPv4 or IPv6, as a string. The loopback +address is ,(code ["127.0.0.1"]) and ,(code ["::1"]) for IPv4 and IPv6 +respectively. The any address is ,(code ["0.0.0.0"]) and ,(code +["::"]) for IPv4 and IPv6 respectively.]) + (record-field "port" + [Port number to listen on.])) + (record-documentation "guix/forge/socket.scm" ' + (record-field "path" + [Path to socket file.])) (record-documentation "guix/forge/webhook.scm" ' (record-field "package" [,(code [webhook]) package to use]) -- cgit v1.2.3