package volgo

  1. Overview
  2. Docs
package volgo
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Platform_repo.Ssh_syntaxSource

There are two style of SSH addresses used by popular platforms.

  • Scp_like: The traditional "scp-like" syntax, e.g. git@github.com:user/repo.git.
  • Url_style: The "ssh://" URL style, e.g. ssh://git@codeberg.org/user/repo.git.

This types allows to distinguish between the two and is used as parameter by functions that generate the concrete syntax for a url to a platform repo, to be used e.g. when cloning, or configuring a remote.

Sourcetype t =
  1. | Scp_like
  2. | Url_style
Sourceval compare : t -> t -> int
Sourceval equal : t -> t -> bool
Sourceval hash : t -> int
Sourceval seeded_hash : int -> t -> int
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval all : t list
Sourceval used_by_default_on_platform : platform:Platform.t -> t

Each platform has a default behavior in that they have a style of ssh url they use when displaying the addresses of the repos. Note that they can probably handle all styles when parsing the url.

Beware, this may probably change overtime as platforms evolve.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct