]> git.proxmox.com Git - pve-common.git/blobdiff - README.dev
JSONSchema: Add format for MAC address verification
[pve-common.git] / README.dev
index bbd84f38f5a3551af3bbd3157d5f8ff13dd23e74..09631c09016c3b5954a8b23c6a262e29d85ebfd5 100644 (file)
@@ -1,7 +1,8 @@
 = Setup PVE Development Environment =
 
 0.  Read https://pve.proxmox.com/wiki/Developer_Documentation
-1.  Install Debian 9 'stretch'
+1.  Install Debian 9 'stretch' (you can also start from a PVE installation and
+    skip step 2 - 5, 7 - 11)
 2.  Configure the network interface(s)
 3.  Change the IP address of your hostname for proper name resolution
     in /etc/hosts
 
 = Install build prerequisites for development environment =
 
-12. run:
+NOTE: this is a huge list intended to be able to build (almost) all packages,
+from the UI/API components to backend components to our Linux Kernel.
+If you only want to hack on specific topics you won't need most of those.
+We try to have a complete list of build dependencies in each source
+repositories 'debian/control' file. If you run `make deb` dpkg-buildpackage will
+stop and tell you if you miss some required packages.
 
-apt-get install build-essential git git-email debhelper \
-autotools-dev autogen dh-autoreconf dkms doxygen check pkg-config \
+12. For installing the most important, always needed, ones run:
+
+apt-get install build-essential git git-email debhelper pve-doc-generator
+
+Additionally, for quickly installing (almost) all build dependencies run:
+
+apt-get install autotools-dev autogen dh-autoreconf dkms doxygen check pkg-config \
 groff quilt dpatch automake autoconf libtool lintian libdevel-cycle-perl \
 libjson-perl libcommon-sense-perl liblinux-inotify2-perl libio-stringy-perl \
 libstring-shellquote-perl dh-systemd rpm2cpio libsqlite3-dev sqlite3 \
@@ -62,7 +73,8 @@ libcpg-dev libquorum-dev libcmap-dev libuuid-perl \
 libqb-dev libapparmor-dev docbook2x libcap-dev dh-apparmor \
 graphviz libseccomp-dev libglib-perl libgtk3-perl libnss3-dev libdlm-dev \
 libudev-dev asciidoc-dblatex source-highlight libiscsi-dev libiscsi7 \
-librsvg2-bin
+librsvg2-bin libarchive-dev libgpgme-dev libcurl4-gnutls-dev \
+libtest-mockmodule-perl libjemalloc-dev libjpeg-dev
 
 
 = Compile PVE packages from Source =