Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-21 Thread osmith 
osmith has submitted this change and it was merged. ( 
https://gerrit.osmocom.org/11740 )

Change subject: publish from project repos, not this repo anymore
..

publish from project repos, not this repo anymore

Do not publish PDFs for all projects anymore with jenkins.sh --publish
or "make publish". Extract known_hosts from jenkins.sh, and install it
along with the other shared files in OSMO_GSM_MANUALS_DIR. Add a
"publish" target to Makefile.common.inc, so we can use it from the
project repositories. Document its usage in INSTALL.txt.

No automatism for building and publishing the documentation of all
projects will be implemented in this patch series, as discussed here:
https://osmocom.org/issues/3385#note-7

(moving manuals to project repositories 19/19)

Related: OS#3385
Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
---
M INSTALL.txt
M build/Makefile.common.inc
A build/known_hosts
M contrib/jenkins.sh
4 files changed, 32 insertions(+), 18 deletions(-)

Approvals:
  Neels Hofmeyr: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/INSTALL.txt b/INSTALL.txt
index 6efe8d1..c3caefe 100644
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -14,13 +14,26 @@

 (Note that asciidoc-dblatex is required from debian 9 on and did not exist 
before.)

-Build PDFs, run:
+Prepare your build dir:
   autoreconf -fi
   ./configure
-  make

-or for a parallel build using more CPU cores, replace make with:
-  make -j 5
+Optionally test building all shared content (use -j for parallel building):
+  make# generate test PDFs
+  make check  # test for asciidoc errors
+
+Install osmo-gsm-manuals:
+  make install
+
+Build the manuals of a specific Osmocom project:
+  cd ../osmo-msc# enter the project dir, clone first if needed
+  ./configure --enable-manuals
+  make
+  ls doc/manuals/*.pdf  # find the PDFs here
+
+Publish PDFs to the Osmocom server:
+  cd ../osmo-msc  # enter the project dir
+  make -C doc/manuals publish

 To update the VTY reference for a given program, use 'osmo_interact_vty.py -X',
 available from git.osmocom.org/python/osmo-python-tests:
diff --git a/build/Makefile.common.inc b/build/Makefile.common.inc
index efd56f6..0ee648a 100644
--- a/build/Makefile.common.inc
+++ b/build/Makefile.common.inc
@@ -5,6 +5,7 @@
 #
 # Include this file at the end to have the common targets (upload, clean etc.).

+SSH_COMMAND = ssh -o 
'UserKnownHostsFile=$(OSMO_GSM_MANUALS_DIR)/build/known_hosts' -p 48
 UPLOAD_PATH ?= generic@sysmocom-downloads:documents
 SYMLINKS = common build
 CLEAN_FILES += $(SYMLINKS)
@@ -19,3 +20,8 @@
-rm -rf $(CLEAN_FILES)

 distclean: clean
+
+publish: all check
+   mkdir -p out
+   cp *.pdf out
+   rsync -avz -e "$(SSH_COMMAND)" ./out/ 
d...@rita.osmocom.org:web-files/latest/
diff --git a/build/known_hosts b/build/known_hosts
new file mode 100644
index 000..c78b03d
--- /dev/null
+++ b/build/known_hosts
@@ -0,0 +1,3 @@
+[rita.osmocom.org]:48 ssh-rsa 
B3NzaC1yc2EDAQABAAABAQDDgQ9HntlpWNmh953a2Gc8NysKE4orOatVT1wQkyzhARnfYUerRuwyNr1GqMyBKdSI9amYVBXJIOUFcpV81niA7zQRUs66bpIMkE9/rHxBd81SkorEPOIS84W4vm3SZtuNqa+fADcqe88Hcb0ZdTzjKILuwi19gzrQyME2knHY71EOETe9Yow5RD2hTIpB5ecNxI0LUKDq+Ii8HfBvndPBIr0BWYDugckQ3Bocf+yn/tn2/GZieFEyFpBGF/MnLbAAfUKIdeyFRX7ufaiWWz5yKAfEhtziqdAGZaXNaLG6gkpy3EixOAy6ZXuTAk3b3Y0FUmDjhOHllbPmTOcKMry9
+[rita.osmocom.org]:48 ecdsa-sha2-nistp256 
E2VjZHNhLXNoYTItbmlzdHAyNTYIbmlzdHAyNTYAAABBBPdWn1kEousXuKsZ+qJEZTt/NSeASxCrUfNDW3LWtH+d8Ust7ZuKp/vuyG+5pe5pwpPOgFu7TjN+0lVjYJVXH54=
+[rita.osmocom.org]:48 ssh-ed25519 
C3NzaC1lZDI1NTE5IK8iivY70EiR5NiGChV39gRLjNpC8lvu1ZdHtdMw2zuX
diff --git a/contrib/jenkins.sh b/contrib/jenkins.sh
index 626160e..7d4d8df 100755
--- a/contrib/jenkins.sh
+++ b/contrib/jenkins.sh
@@ -2,7 +2,12 @@

 set -ex

-publish="$1"
+if [ -n "$1" ]; then
+echo "ERROR: --publish has been deprecated!"
+echo "Manuals have been moved to the projects, and need to be published 
from there."
+echo "See INSTALL.txt for more information."
+exit 1
+fi

 osmo-clean-workspace.sh

@@ -12,17 +17,4 @@
 $MAKE $PARALLEL_MAKE check
 $MAKE $PARALLEL_MAKE distcheck

-if [ "x$publish" = "x--publish" ]; then
-  mkdir out/
-  cp */*.pdf out/
-
-  cat > "$WORKSPACE/known_hosts"

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-21 Thread Neels Hofmeyr 
Neels Hofmeyr has posted comments on this change. ( 
https://gerrit.osmocom.org/11740 )

Change subject: publish from project repos, not this repo anymore
..


Patch Set 5: Code-Review+2


--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 5
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Neels Hofmeyr 
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-Reviewer: osmith 
Gerrit-Comment-Date: Wed, 21 Nov 2018 14:06:49 +
Gerrit-HasComments: No
Gerrit-HasLabels: Yes

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-21 Thread osmith 
Hello Pau Espin Pedrol, Neels Hofmeyr, Harald Welte, Jenkins Builder,

I'd like you to reexamine a change. Please visit

https://gerrit.osmocom.org/11740

to look at the new patch set (#5).

Change subject: publish from project repos, not this repo anymore
..

publish from project repos, not this repo anymore

Do not publish PDFs for all projects anymore with jenkins.sh --publish
or "make publish". Extract known_hosts from jenkins.sh, and install it
along with the other shared files in OSMO_GSM_MANUALS_DIR. Add a
"publish" target to Makefile.common.inc, so we can use it from the
project repositories. Document its usage in INSTALL.txt.

No automatism for building and publishing the documentation of all
projects will be implemented in this patch series, as discussed here:
https://osmocom.org/issues/3385#note-7

(moving manuals to project repositories 19/19)

Related: OS#3385
Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
---
M INSTALL.txt
M build/Makefile.common.inc
A build/known_hosts
M contrib/jenkins.sh
4 files changed, 32 insertions(+), 18 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals 
refs/changes/40/11740/5
--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: newpatchset
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 5
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Neels Hofmeyr 
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-Reviewer: osmith

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-21 Thread Neels Hofmeyr 
Neels Hofmeyr has posted comments on this change. ( 
https://gerrit.osmocom.org/11740 )

Change subject: publish from project repos, not this repo anymore
..


Patch Set 4: Code-Review+1

(fix the build failure)


--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 4
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Neels Hofmeyr 
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-Reviewer: osmith 
Gerrit-Comment-Date: Wed, 21 Nov 2018 13:06:33 +
Gerrit-HasComments: No
Gerrit-HasLabels: Yes

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-20 Thread Pau Espin Pedrol 
Pau Espin Pedrol has posted comments on this change. ( 
https://gerrit.osmocom.org/11740 )

Change subject: publish from project repos, not this repo anymore
..


Patch Set 4: Code-Review+1

Leaving +2 for Neels and his comments.


--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 4
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Neels Hofmeyr 
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-Reviewer: osmith 
Gerrit-Comment-Date: Tue, 20 Nov 2018 17:53:50 +
Gerrit-HasComments: No
Gerrit-HasLabels: Yes

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-20 Thread osmith 
Hello Pau Espin Pedrol, Neels Hofmeyr, Harald Welte, Jenkins Builder,

I'd like you to reexamine a change. Please visit

https://gerrit.osmocom.org/11740

to look at the new patch set (#3).

Change subject: publish from project repos, not this repo anymore
..

publish from project repos, not this repo anymore

Do not publish PDFs for all projects anymore with jenkins.sh --publish
or "make publish". Extract known_hosts from jenkins.sh, and install it
along with the other shared files in OSMO_GSM_MANUALS_DIR. Add a
"publish" target to Makefile.common.inc, so we can use it from the
project repositories. Document its usage in INSTALL.txt.

No automatism for building and publishing the documentation of all
projects will be implemented in this patch series, as discussed here:
https://osmocom.org/issues/3385#note-7

(moving manuals to project repositories 19/19)

Related: OS#3385
Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
---
M INSTALL.txt
M build/Makefile.common.inc
A build/known_hosts
M contrib/jenkins.sh
4 files changed, 32 insertions(+), 18 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals 
refs/changes/40/11740/3
--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: newpatchset
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 3
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Neels Hofmeyr 
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-Reviewer: osmith

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-20 Thread osmith 
osmith has posted comments on this change. ( https://gerrit.osmocom.org/11740 )

Change subject: publish from project repos, not this repo anymore
..


Patch Set 2:

(2 comments)

https://gerrit.osmocom.org/#/c/11740/2/contrib/jenkins.sh
File contrib/jenkins.sh:

https://gerrit.osmocom.org/#/c/11740/2/contrib/jenkins.sh@7
PS2, Line 7: echo "Manuals have been moved to the projects, and need to be 
published from there."
> Mentiond that "make publish" exists now?
I will added it to the INSTALL.txt and refer to that instead of the wiki page.


https://gerrit.osmocom.org/#/c/11740/2/contrib/jenkins.sh@9
PS2, Line 9: echo 
""
> why the <...> braces though?

I've seen this in license texts (e.g. GPL headers) and then doing it like that, 
but that's not a good reason. I'll omit this in the future.

> Are you planning on adding info to that wiki page? so far it doesn't have 
> anything about publishing, except some half-hearted dependency list.

That was the idea.

> In fact, I think the place that explained how to publish so far was the 
> osmo-gsm-manuals/README .. or INSTALL.txt. Maybe link there instead, also 
> from the wiki page, and fully explain there?

Right, I will extended the INSTALL.txt instead and refer to that file. Also the 
wiki page links to that file now instead of showing the incomplete dependency 
list.



--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 2
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Neels Hofmeyr 
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-Reviewer: osmith 
Gerrit-Comment-Date: Tue, 20 Nov 2018 14:53:21 +
Gerrit-HasComments: Yes
Gerrit-HasLabels: No

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-19 Thread Neels Hofmeyr 
Neels Hofmeyr has posted comments on this change. ( 
https://gerrit.osmocom.org/11740 )

Change subject: publish from project repos, not this repo anymore
..


Patch Set 2: Code-Review+1

(1 comment)

https://gerrit.osmocom.org/#/c/11740/2/contrib/jenkins.sh
File contrib/jenkins.sh:

https://gerrit.osmocom.org/#/c/11740/2/contrib/jenkins.sh@9
PS2, Line 9: echo 
""
why the <...> braces though?

Are you planning on adding info to that wiki page? so far it doesn't have 
anything about publishing, except some half-hearted dependency list.

In fact, I think the place that explained how to publish so far was the 
osmo-gsm-manuals/README .. or INSTALL.txt. Maybe link there instead, also from 
the wiki page, and fully explain there?



--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 2
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Neels Hofmeyr 
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-Comment-Date: Tue, 20 Nov 2018 02:19:38 +
Gerrit-HasComments: Yes
Gerrit-HasLabels: Yes

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-16 Thread Pau Espin Pedrol 
Pau Espin Pedrol has posted comments on this change. ( 
https://gerrit.osmocom.org/11740 )

Change subject: publish from project repos, not this repo anymore
..


Patch Set 2:

(1 comment)

https://gerrit.osmocom.org/#/c/11740/2/contrib/jenkins.sh
File contrib/jenkins.sh:

https://gerrit.osmocom.org/#/c/11740/2/contrib/jenkins.sh@7
PS2, Line 7: echo "Manuals have been moved to the projects, and need to be 
published from there."
Mentiond that "make publish" exists now?



--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 2
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-CC: Neels Hofmeyr 
Gerrit-Comment-Date: Fri, 16 Nov 2018 16:53:09 +
Gerrit-HasComments: Yes
Gerrit-HasLabels: No

Change in osmo-gsm-manuals[master]: publish from project repos, not this repo anymore

2018-11-16 Thread osmith 
Hello Pau Espin Pedrol, Harald Welte, Jenkins Builder,

I'd like you to reexamine a change. Please visit

https://gerrit.osmocom.org/11740

to look at the new patch set (#2).

Change subject: publish from project repos, not this repo anymore
..

publish from project repos, not this repo anymore

Do not publish PDFs for all projects anymore with jenkins.sh --publish
or "make publish". Extract known_hosts from jenkins.sh, and install it
along with the other shared files in OSMO_GSM_MANUALS_DIR. Add a
"publish" target to Makefile.common.inc, so we can use it from the
project repositories:

$ cd docs/manuals
$ make publish

No automatism for building and publishing the documentation of all
projects will be implemented in this patch series, as discussed here:
https://osmocom.org/issues/3385#note-7

(moving manuals to project repositories 14/16)

Related: OS#3385
Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
---
M build/Makefile.common.inc
A build/known_hosts
M contrib/jenkins.sh
3 files changed, 16 insertions(+), 14 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals 
refs/changes/40/11740/2
--
To view, visit https://gerrit.osmocom.org/11740
To unsubscribe, or for help writing mail filters, visit 
https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-MessageType: newpatchset
Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
Gerrit-Change-Number: 11740
Gerrit-PatchSet: 2
Gerrit-Owner: osmith 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder (102)
Gerrit-Reviewer: Pau Espin Pedrol 
Gerrit-CC: Neels Hofmeyr