Merge lp:~dsmythies/serverguide/makefile_changes into lp:~ubuntu-core-doc/serverguide/raring

Proposed by Doug Smythies
Status: Merged
Approved by: Doug Smythies
Approved revision: no longer in the source branch.
Merged at revision: 118
Proposed branch: lp:~dsmythies/serverguide/makefile_changes
Merge into: lp:~ubuntu-core-doc/serverguide/raring
Diff against target: 251 lines (+58/-135)
6 files modified
Makefile (+15/-1)
serverguide/C/mail.xml (+43/-2)
serverguide/sample/posfix_commands.sh (+0/-31)
serverguide/sample/postfix_configuration (+0/-40)
serverguide/sample/resolv.conf (+0/-5)
serverguide/sample/sources.list (+0/-56)
To merge this branch: bzr merge lp:~dsmythies/serverguide/makefile_changes
Reviewer Review Type Date Requested Status
Doug Smythies Approve
Review via email: mp+155154@code.launchpad.net

Description of the change

This MP has changes to the Makefile and mail.xml dealing with LP: #1159144 and LP: #972925.

The serverguide HTML was not centered (at least on some browsers), and the methods used in the desktop documentation were pretty much copied to the serverguide Makefile.

There were obsolete and no longer used files in the sample sub-directory. The one file that was still being used was moved to within <programlisting> tags in-line in mail.xml, and the entire sample sub-directory was removed. Why? Because the PDF document must stand by itself and not have relative links to somewhere that doesn't exist if the PDF has been copied elsewhere.

Note: I have no clue what this line in the Makfile does:
                lang=`echo $(LN) | $(SED) -e 's/[@_]/-/'`; \
and I have mindlessly copied it from the desktop Makefile. It might be the case that it is not required for the serverguide.

I realize that the more experienced documentation committers that actually know what is going on and the reasons for that way things are (were) have backed off. However I hope that they will review this.

To post a comment you must log in.
Revision history for this message
Doug Smythies (dsmythies) wrote :

I would be very grateful if someone would review this MP. There will be conflicts (I think) with some coming stuff if not dealt with.
I'll proably wait another day, and then just do it myself, as string freeze is coming and there is still much to do.

Revision history for this message
Doug Smythies (dsmythies) wrote :

I had hoped for someone else to review this, but now will just self approve and merge it.
I'll beg forgivness later if it causes problems.
There isn't much time left before string freeze, with still lots to do, and limited time available to dedicate to the serverguide.

review: Approve
118. By Doug Smythies

Edits per MP: #155154; LP: #1159171 and LP: #972925 center html and eliminate sample directory; by Doug Smythies

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'Makefile'
--- Makefile 2012-04-06 12:53:52 +0000
+++ Makefile 2013-03-24 22:58:21 +0000
@@ -20,6 +20,7 @@
20####################################################################################20####################################################################################
2121
22MAKECMD=make22MAKECMD=make
23SED=/bin/sed
2324
24# Language code for documents25# Language code for documents
25# Ex. LN=ja for japanese26# Ex. LN=ja for japanese
@@ -61,15 +62,28 @@
6162
62serverguide-html:63serverguide-html:
6364
65# Builds the HTML files for the specified language codes.
66# Specifiying the language in the final documents and
67# performing some other necessary text replacements not handled by yelp-build.
68# Language codes are normalized to IETF format, as opposed to glibc format
69
64 if [ $(LN) != "C" ]; then \70 if [ $(LN) != "C" ]; then \
65 ./scripts/translate.sh -d serverguide -l $(LN); \71 ./scripts/translate.sh -d serverguide -l $(LN); \
66 fi72 fi
67 if find serverguide/$(LN) -name "*.xml"; then \73 if find serverguide/$(LN) -name "*.xml"; then \
68 mkdir -p build/serverguide/$(LN); \74 mkdir -p build/serverguide/$(LN); \
69 yelp-build html -o build/serverguide/$(LN) -x $(UBUNTUXSL) serverguide/$(LN)/serverguide.xml; \75 yelp-build html -o build/serverguide/$(LN) -x $(UBUNTUXSL) serverguide/$(LN)/serverguide.xml; \
70 cp -r serverguide/sample build/serverguide/; \
71 mkdir -p build/img; \76 mkdir -p build/img; \
72 cp libs/img/* build/img/; \77 cp libs/img/* build/img/; \
78 lang=`echo $(LN) | $(SED) -e 's/[@_]/-/'`; \
79 if test "$$lang" = "C"; then lang=en; fi; \
80 if test "$$lang" = "gl"; then lang=gl-GL; fi; \
81 if test "$$lang" = "ms"; then lang=ms-MS; fi; \
82 if test "$$lang" = "pl"; then lang=pl-PL; fi; \
83 $(SED) -i \
84 -e '1s/^/<!DOCTYPE html\>\n/' \
85 -e "s/<html>/<html lang="$$lang">/" \
86 build/serverguide/$(LN)/*.html; \
73 fi87 fi
7488
75serverguide-pdf:89serverguide-pdf:
7690
=== modified file 'serverguide/C/mail.xml'
--- serverguide/C/mail.xml 2013-03-06 00:22:48 +0000
+++ serverguide/C/mail.xml 2013-03-24 22:58:21 +0000
@@ -182,9 +182,50 @@
182 </para>182 </para>
183 </note>183 </note>
184 <para>184 <para>
185 Now, the file <filename>/etc/postfix/main.cf</filename>185 Now, the file <filename>/etc/postfix/main.cf</filename> should look like this:
186 should look like <ulink url="../sample/postfix_configuration">this</ulink>.
187 </para>186 </para>
187<programlisting>
188# See /usr/share/postfix/main.cf.dist for a commented, more complete
189# version
190
191smtpd_banner = $myhostname ESMTP $mail_name (Ubuntu)
192biff = no
193
194# appending .domain is the MUA's job.
195append_dot_mydomain = no
196
197# Uncomment the next line to generate "delayed mail" warnings
198#delay_warning_time = 4h
199
200myhostname = server1.example.com
201alias_maps = hash:/etc/aliases
202alias_database = hash:/etc/aliases
203myorigin = /etc/mailname
204mydestination = server1.example.com, localhost.example.com, localhost
205relayhost =
206mynetworks = 127.0.0.0/8
207mailbox_command = procmail -a "$EXTENSION"
208mailbox_size_limit = 0
209recipient_delimiter = +
210inet_interfaces = all
211smtpd_sasl_local_domain =
212smtpd_sasl_auth_enable = yes
213smtpd_sasl_security_options = noanonymous
214broken_sasl_auth_clients = yes
215smtpd_recipient_restrictions =
216permit_sasl_authenticated,permit_mynetworks,reject _unauth_destination
217smtpd_tls_auth_only = no
218smtp_tls_security_level = may
219smtpd_tls_security_level = may
220smtp_tls_note_starttls_offer = yes
221smtpd_tls_key_file = /etc/ssl/private/smtpd.key
222smtpd_tls_cert_file = /etc/ssl/certs/smtpd.crt
223smtpd_tls_CAfile = /etc/ssl/certs/cacert.pem
224smtpd_tls_loglevel = 1
225smtpd_tls_received_header = yes
226smtpd_tls_session_cache_timeout = 3600s
227tls_random_source = dev:/dev/urandom
228</programlisting>
188 <para>229 <para>
189 The postfix initial configuration is complete. Run230 The postfix initial configuration is complete. Run
190 the following command to restart the postfix daemon:231 the following command to restart the postfix daemon:
191232
=== removed directory 'serverguide/sample'
=== removed file 'serverguide/sample/posfix_commands.sh'
--- serverguide/sample/posfix_commands.sh 2011-05-03 07:11:18 +0000
+++ serverguide/sample/posfix_commands.sh 1970-01-01 00:00:00 +0000
@@ -1,31 +0,0 @@
1postconf -e 'smtpd_sasl_local_domain ='
2postconf -e 'smtpd_sasl_auth_enable = yes'
3postconf -e 'smtpd_sasl_security_options = noanonymous'
4postconf -e 'broken_sasl_auth_clients = yes'
5postconf -e 'smtpd_recipient_restrictions = permit_sasl_authenticated,permit_mynetworks,reject_unauth_destination'
6postconf -e 'inet_interfaces = all'
7echo 'pwcheck_method: saslauthd' >> /etc/postfix/sasl/smtpd.conf
8echo 'mech_list: plain login' >> /etc/postfix/sasl/smtpd.conf
9
10mkdir /etc/postfix/ssl
11cd /etc/postfix/ssl/
12openssl genrsa -des3 -rand /etc/hosts -out smtpd.key 1024
13chmod 600 smtpd.key
14openssl req -new -key smtpd.key -out smtpd.csr
15openssl x509 -req -days 3650 -in smtpd.csr -signkey smtpd.key -out smtpd.crt
16openssl rsa -in smtpd.key -out smtpd.key.unencrypted
17mv -f smtpd.key.unencrypted smtpd.key
18openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.pem -days 3650
19
20postconf -e 'smtpd_tls_auth_only = no'
21postconf -e 'smtp_tls_security_level = may'
22postconf -e 'smtpd_tls_security_level = may'
23postconf -e 'smtp_tls_note_starttls_offer = yes'
24postconf -e 'smtpd_tls_key_file = /etc/postfix/ssl/smtpd.key'
25postconf -e 'smtpd_tls_cert_file = /etc/postfix/ssl/smtpd.crt'
26postconf -e 'smtpd_tls_CAfile = /etc/postfix/ssl/cacert.pem'
27postconf -e 'smtpd_tls_loglevel = 1'
28postconf -e 'smtpd_tls_received_header = yes'
29postconf -e 'smtpd_tls_session_cache_timeout = 3600s'
30postconf -e 'tls_random_source = dev:/dev/urandom'
31postconf -e 'myhostname = mail.example.com'
320
=== removed file 'serverguide/sample/postfix_configuration'
--- serverguide/sample/postfix_configuration 2011-05-03 07:11:18 +0000
+++ serverguide/sample/postfix_configuration 1970-01-01 00:00:00 +0000
@@ -1,40 +0,0 @@
1# See /usr/share/postfix/main.cf.dist for a commented, more complete
2# version
3
4smtpd_banner = $myhostname ESMTP $mail_name (Ubuntu)
5biff = no
6
7# appending .domain is the MUA's job.
8append_dot_mydomain = no
9
10# Uncomment the next line to generate "delayed mail" warnings
11#delay_warning_time = 4h
12
13myhostname = server1.example.com
14alias_maps = hash:/etc/aliases
15alias_database = hash:/etc/aliases
16myorigin = /etc/mailname
17mydestination = server1.example.com, localhost.example.com, localhost
18relayhost =
19mynetworks = 127.0.0.0/8
20mailbox_command = procmail -a "$EXTENSION"
21mailbox_size_limit = 0
22recipient_delimiter = +
23inet_interfaces = all
24smtpd_sasl_local_domain =
25smtpd_sasl_auth_enable = yes
26smtpd_sasl_security_options = noanonymous
27broken_sasl_auth_clients = yes
28smtpd_recipient_restrictions =
29permit_sasl_authenticated,permit_mynetworks,reject _unauth_destination
30smtpd_tls_auth_only = no
31smtp_tls_security_level = may
32smtpd_tls_security_level = may
33smtp_tls_note_starttls_offer = yes
34smtpd_tls_key_file = /etc/ssl/private/smtpd.key
35smtpd_tls_cert_file = /etc/ssl/certs/smtpd.crt
36smtpd_tls_CAfile = /etc/ssl/certs/cacert.pem
37smtpd_tls_loglevel = 1
38smtpd_tls_received_header = yes
39smtpd_tls_session_cache_timeout = 3600s
40tls_random_source = dev:/dev/urandom
410
=== removed file 'serverguide/sample/resolv.conf'
--- serverguide/sample/resolv.conf 2011-05-03 07:11:18 +0000
+++ serverguide/sample/resolv.conf 1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
1search com
2nameserver 204.11.126.131
3nameserver 64.125.134.133
4nameserver 64.125.134.132
5nameserver 208.185.179.218
60
=== removed file 'serverguide/sample/sources.list'
--- serverguide/sample/sources.list 2012-10-18 06:32:10 +0000
+++ serverguide/sample/sources.list 1970-01-01 00:00:00 +0000
@@ -1,56 +0,0 @@
1# deb cdrom:[Ubuntu 12.10 _Quantal Quetzal_ - Beta i386 (20120421)]/ quantal main restricted
2
3# See http://help.ubuntu.com/community/UpgradeNotes for how to upgrade to
4# newer versions of the distribution.
5deb http://us.archive.ubuntu.com/ubuntu/ quantal main restricted
6deb-src http://us.archive.ubuntu.com/ubuntu/ quantal main restricted
7
8## Major bug fix updates produced after the final release of the
9## distribution.
10deb http://us.archive.ubuntu.com/ubuntu/ quantal-updates main restricted
11deb-src http://us.archive.ubuntu.com/ubuntu/ quantal-updates main restricted
12
13## N.B. software from this repository is ENTIRELY UNSUPPORTED by the Ubuntu
14## team. Also, please note that software in universe WILL NOT receive any
15## review or updates from the Ubuntu security team.
16deb http://us.archive.ubuntu.com/ubuntu/ quantal universe
17deb-src http://us.archive.ubuntu.com/ubuntu/ quantal universe
18deb http://us.archive.ubuntu.com/ubuntu/ quantal-updates universe
19deb-src http://us.archive.ubuntu.com/ubuntu/ quantal-updates universe
20
21## N.B. software from this repository is ENTIRELY UNSUPPORTED by the Ubuntu
22## team, and may not be under a free licence. Please satisfy yourself as to
23## your rights to use the software. Also, please note that software in
24## multiverse WILL NOT receive any review or updates from the Ubuntu
25## security team.
26deb http://us.archive.ubuntu.com/ubuntu/ quantal multiverse
27deb-src http://us.archive.ubuntu.com/ubuntu/ quantal multiverse
28deb http://us.archive.ubuntu.com/ubuntu/ quantal-updates multiverse
29deb-src http://us.archive.ubuntu.com/ubuntu/ quantal-updates multiverse
30
31## N.B. software from this repository may not have been tested as
32## extensively as that contained in the main release, although it includes
33## newer versions of some applications which may provide useful features.
34## Also, please note that software in backports WILL NOT receive any review
35## or updates from the Ubuntu security team.
36deb http://us.archive.ubuntu.com/ubuntu/ quantal-backports main restricted universe multiverse
37deb-src http://us.archive.ubuntu.com/ubuntu/ quantal-backports main restricted universe multiverse
38
39deb http://security.ubuntu.com/ubuntu quantal-security main restricted
40deb-src http://security.ubuntu.com/ubuntu quantal-security main restricted
41deb http://security.ubuntu.com/ubuntu quantal-security universe
42deb-src http://security.ubuntu.com/ubuntu quantal-security universe
43deb http://security.ubuntu.com/ubuntu quantal-security multiverse
44deb-src http://security.ubuntu.com/ubuntu quantal-security multiverse
45
46## Uncomment the following two lines to add software from Canonical's
47## 'partner' repository.
48## This software is not part of Ubuntu, but is offered by Canonical and the
49## respective vendors as a service to Ubuntu users.
50# deb http://archive.canonical.com/ubuntu quantal partner
51# deb-src http://archive.canonical.com/ubuntu quantal partner
52
53## This software is not part of Ubuntu, but is offered by third-party
54## developers who want to ship their latest software.
55deb http://extras.ubuntu.com/ubuntu quantal main
56deb-src http://extras.ubuntu.com/ubuntu quantal main

Subscribers

People subscribed via source and target branches