Skip to content

Commit a76f499

Browse files
committed
add doc/DEVELOP.md instead of doc/README.md
1 parent 36e45cd commit a76f499

File tree

2 files changed

+70
-11
lines changed

2 files changed

+70
-11
lines changed

doc/DEVELOP.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
2+
3+
## Build mscp as deb package
4+
5+
`make build-deb` produces a mscp deb package and related files. This
6+
target builds mscp with `debuild` inside a docker container
7+
(Dockerfile is `docker/build-deb.Docerfile`).
8+
9+
10+
```console
11+
mkdir build && cd build && cmake ..
12+
make build-deb
13+
```
14+
15+
After that:
16+
17+
```console
18+
$ ls debbuild
19+
mscp_0.1.3_amd64.build mscp_0.1.3_amd64.deb mscp-dbgsym_0.1.3_amd64.ddeb
20+
mscp_0.1.3_amd64.buildinfo mscp_0.1.3.dsc
21+
mscp_0.1.3_amd64.changes mscp_0.1.3.tar.xz
22+
```
23+
24+
### To publush mscp in launchpad PPA:
25+
26+
1. write changes in `debian/changelog` at main branch (the date command needed here is `date -R`)
27+
2. switch to `ppa-focal` or `ppa-jammy` branch
28+
3. reblase to the `main` branch and modify `debian/changes`:
29+
* change `UNRELEASED` to the release name (`focal` or `jammy`).
30+
4. run `make build-deb` at the build directory and `cd debbuild`
31+
5. sign the files with `debsign -k [GPGKEYID] mscp_X.X.X~X_source.changes`
32+
5. upload the files with `dput ppa:upaa/mscp mscp_X.X.X~X_source.changes`
33+
34+
35+
## Build mscp as (source) rpm package
36+
37+
`make build-srpm` produces a mscp src.rpm package. This target builts
38+
mscp with `rpmbuild` inside a docker container (Dockerfile is
39+
`docker/build-srpm.Dockerfile`, generated from
40+
`build-srpm.Dockerfile.in` by cmake).
41+
42+
```console
43+
mkdir build && cd build && cmake ..
44+
make build-srpm
45+
```
46+
47+
After that:
48+
49+
```console
50+
$ ls *.rpm
51+
mscp-0.1.3-1.el9.src.rpm
52+
```
53+
54+
### To bpulish mscp in COPR:
55+
56+
1. download mscp-X.X.X-1.yyy.src.rpm
57+
2. upload the src.rpm to Build page at COPR.
58+
59+
60+
61+
## Update Document
62+
63+
The docuemnt is `doc/mscp.rst` (at present). When `mscp.1.in`
64+
is updated, run `make update-rst` to make it up to date.
65+
66+
```console
67+
mkdir build cd build && cmake ..
68+
make update-rst
69+
```
70+

doc/README.md

-11
This file was deleted.

0 commit comments

Comments
 (0)