tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
2,152 Commits 2 Branches 54 Tags 14 MiB
Rust 88.1%
JavaScript 11.3%
Makefile 0.3%
CSS 0.2%
4f3db187cf
Go to file
Aaron Lauterer 4f3db187cf Docu: first proof reading 
This is a first proof reading of the currently existing documentation.

fixes (hopefully all):
* spelling
* grammar

Tries to increase readabilty and ease of understanding by simplifying
and restructing some sentences and paragraphs. Filler words which add
to the cognitive load but don't add anything are removed
(most notably `also`).
2020-04-15 06:52:59 +02:00
.cargo cargo: switch to use packaged crates by default 2020-01-03 09:40:33 +01:00
debian add 'rsync' to build_depends 2020-03-18 16:24:33 +01:00
docs Docu: first proof reading 2020-04-15 06:52:59 +02:00
etc s/pbsbanner/proxmox-backup-banner/ + move to /usr/lib 2020-02-10 14:43:28 +01:00
src pxar extract: remove pattern from arg_param, add target instead 2020-04-15 06:41:37 +02:00
tests fixup tests for the new proxmox crate layout 2020-01-22 10:08:40 +01:00
www gui: improve login view (use realms) 2020-04-09 13:37:14 +02:00
zsh-completions Add zsh completion scripts 2020-02-27 06:50:14 +01:00
.gitignore add Cargo.lock 2019-09-02 15:21:56 +02:00
Cargo.toml depend on proxmox 0.1.20 2020-03-25 15:17:16 +01:00
defines.mk Add zsh completion scripts 2020-02-27 06:50:14 +01:00
Makefile Makefile - upload: upload to correct product repos 2020-03-03 10:56:07 +01:00
README.rst remove the rust-toolchain file 2020-01-16 10:45:46 +01:00
rustfmt.toml import rustfmt.toml 2019-08-22 13:44:57 +02:00
TODO.rst TODO.rst: add Chores section 2020-03-02 13:40:18 +01:00

README.rst 

``rustup`` Toolchain
====================

We normally want to build with the ``rustc`` Debian package. To do that
you can set the following ``rustup`` configuration:

    # rustup toolchain link system /usr
    # rustup default system


Versioning of proxmox helper crates
===================================

To use current git master code of the proxmox* helper crates, add::

   git = "ssh://gitolite3@proxdev.maurer-it.com/rust/proxmox"

or::

   path = "../proxmox/proxmox"

to the proxmox dependency, and update the version to reflect the current,
pre-release version number (e.g., "0.1.1-dev.1" instead of "0.1.0").

Local cargo config
==================

This repository ships with a ``.cargo/config`` that replaces the crates.io
registry with packaged crates located in ``/usr/share/cargo/registry``.

A similar config is also applied building with dh_cargo. Cargo.lock needs to be
deleted when switching between packaged crates and crates.io, since the
checksums are not compatible.

To reference new dependencies (or updated versions) that are not yet packaged,
the dependency needs to point directly to a path or git source (e.g., see
example for proxmox crate above).