mirror of https://github.com/KLayout/klayout.git
Salt package doc update
This commit is contained in:
parent
4222de9034
commit
bc8e1c38f2
|
|
@ -138,8 +138,8 @@
|
||||||
this can be a web server or a folder on
|
this can be a web server or a folder on
|
||||||
a file server. KLayout talks WebDAV, so the web server needs to offer WebDAV
|
a file server. KLayout talks WebDAV, so the web server needs to offer WebDAV
|
||||||
access. A subversion (SVN) server provides WebDAV by default, so this is a good
|
access. A subversion (SVN) server provides WebDAV by default, so this is a good
|
||||||
choice. Git can be used too, but you'll need to mirror the Git repository to
|
choice. For the packages themselves Git or WebDAV/Subversion can be used. You
|
||||||
a file system or WebDAV share.
|
need to specify the protocol in the package URL (see below).
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
|
@ -209,6 +209,62 @@
|
||||||
subversion equivalent.
|
subversion equivalent.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<h2>Generic package URLs</h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Package URLs are the locations from where KLayout will download the package
|
||||||
|
files. The package data is a hierarchy of files. The package description file
|
||||||
|
("grain.xml") needs to be located at the root of this hierarchy.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
A plain package URL will instruct KLayout to download the package file from
|
||||||
|
the given hierarchy using the WebDAV protocol. You can add "svn+" at the front
|
||||||
|
of the URL to make this specification a little more explicit. These are
|
||||||
|
WebDAV/Subversion URLs:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<pre>https://www.klayout.org/example-package
|
||||||
|
svn+https://www.klayout.org/example-package</pre>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Git is another option to host packages. In order to use the Git protocol,
|
||||||
|
add "git+" at the front of the URL:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<pre>git+https://github.com/klayout/example-package.git</pre>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
This will make KLayout clone the "example-package" repository and use the default
|
||||||
|
branch for checking out the files. It will expect a file named "grain.xml" at the
|
||||||
|
root of the package file hierarchy.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
To use a different branch or tag, specify the tag or branch name in square
|
||||||
|
brackes. For example:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<pre>git+https://github.com/klayout/example-package.git[v1.0]</pre>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
This will use the "v1.0" tag or branch for checking out the files.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
It is also possible to have packages in the a subfolder of the repository.
|
||||||
|
To specify the subfolder, separate the subfolder path from the repository
|
||||||
|
URL using "+", like this:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<pre>git+https://github.com/klayout/repository.git+klayout/package-data[v1.0]</pre>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
This will clone the "repository" project and in this project, KLayout will checkout
|
||||||
|
files from "klayout/package-data" and below. This is also the place, where KLayout expects
|
||||||
|
the "grain.xml" file.
|
||||||
|
</p>
|
||||||
|
|
||||||
<h2>Installation Hooks</h2>
|
<h2>Installation Hooks</h2>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue