[openssl-commits] [openssl-book] master update

Matt Caswell matt at openssl.org
Mon Oct 30 10:42:57 UTC 2017

The branch master has been updated
       via  d17bfe6558315ad33d2d4bc2ba3ab9791ac8ff47 (commit)
       via  39a8318b8f2491cfb112ce29ce7459afeff97694 (commit)
      from  7e597bcdb0600f7082a017f454cd5b2b39a0a9f0 (commit)

- Log -----------------------------------------------------------------
commit d17bfe6558315ad33d2d4bc2ba3ab9791ac8ff47
Author: Matt Caswell <matt at openssl.org>
Date:   Fri Oct 27 14:45:46 2017 +0100

    Add initial README, LICENSE and CONTRIBUTING files
    These will need to be updated as we go, but it gives us a starting point.
    Reviewed-by: Tim Hudson <tjh at openssl.org>
    (Merged from https://github.com/openssl/openssl-book/pull/1)

commit 39a8318b8f2491cfb112ce29ce7459afeff97694
Author: Matt Caswell <matt at openssl.org>
Date:   Fri Oct 27 14:15:01 2017 +0100

    Add a bare bones book building structure
    This just creates some bare bones files to give us a starting point for
    generating content. This assumes you have the TeX Live and make available.
    Just run "make" to generate the book pdf.
    Reviewed-by: Tim Hudson <tjh at openssl.org>
    (Merged from https://github.com/openssl/openssl-book/pull/1)


Summary of changes:
 .gitignore                   |  8 ++++++++
 CONTRIBUTING                 | 10 ++++++++++
 LICENSE                      |  8 ++++++++
 Makefile                     | 33 +++++++++++++++++++++++++++++++++
 README                       | 42 ++++++++++++++++++++++++++++++++++++++++++
 introduction/about/about.tex |  3 +++
 openssl-book.tex             | 40 ++++++++++++++++++++++++++++++++++++++++
 7 files changed, 144 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 CONTRIBUTING
 create mode 100644 LICENSE
 create mode 100644 Makefile
 create mode 100644 introduction/about/about.tex
 create mode 100644 openssl-book.tex

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..cb63f1c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,8 @@
+#PDF, aux and log files
+#Top level auto-generated files
new file mode 100644
index 0000000..ddec127
--- /dev/null
@@ -0,0 +1,10 @@
+To report a problem with this guide please open an issue on GitHub.
+To submit a minor patch to this guide please open a pull request on GitHub. Note
+that we do not accept merge commits; You will be asked to remove them before a
+patch is considered acceptable.
+To contribute significant content (e.g. a new chapter) you should also open a
+pull request on GitHub. However please discuss the outline of your chapter
+content on the openssl-dev email list before starting work (see
+https://mta.openssl.org for details).
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..edea9eb
--- /dev/null
@@ -0,0 +1,8 @@
+The License is TBD. It will most likely be one of
+Apache v2 License
+CC-BY 4.0
+The OpenSSL License
+Please only contribute to this project if you are willing for your content to be
+licensed using one of the above or a similar Open Source license.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..e8f82d6
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,33 @@
+# Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
+#Location of the openssl version we are using. May not be the same as the system
+OSSLDIR= /usr/local/ssl
+CC= gcc
+CFLAGS= -I$(OSSLDIR)/include -L$(OSSLDIR)/lib -g -lcrypto -lssl
+#No exe's to build yet
+BOOKELEMS= openssl-book.tex
+all: openssl-book.pdf
+$(EXE): %: %.c
+	$(CC) -o $@ $< $(CFLAGS)
+#We run this twice to ensure that any references etc are updated
+openssl-book.pdf: $(BOOKELEMS) $(EXE)
+	pdflatex openssl-book
+	pdflatex openssl-book
+code: $(EXE)
+	rm $(EXE)
+	rm openssl-book.pdf openssl-book.log openssl-book.aux openssl-book.out
+#Add clean-code here when we actually have code to clean
+clean: clean-book
diff --git a/README b/README
index e69de29..19be246 100644
--- a/README
+++ b/README
@@ -0,0 +1,42 @@
+Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
+The OpenSSL Guide is an attempt to create better documentation for the OpenSSL
+Toolkit. Until now the following types of documentation exist:
+1) Man pages
+2) Wiki
+The man pages are a reference guide and useful for looking up the specific usage
+of a particular command or function. The wiki is a an unreviewed community
+resource which may contain content on a wide range of subjects. Typically this
+content is relatively short and focussed on a particular subject area. The wiki
+is intended to have a relatively low barrier of entry to encourage community
+This book is intended to fill a "gap" in this documentation, i.e. to provide a
+definitive, trusted source of introductory and "guide" style material that will
+enable a reader who is unfamiliar with OpenSSL to learn more about it. It will
+contain content that should enable the reader to get to a level of familiarity
+with OpenSSL that they can then use the other documentation sources (such as the
+man pages) to find detailed information as required.
+NOTE: This is a very initial draft and there is no content in the guide yet!
+Building the OpenSSL Guide
+The following prerequisites are needed in order to build the guide:
+- TeX Live
+- gcc
+- make
+Assuming you have all of the above installed on your system, then creating the
+guide is simply a matter of typing "make" from the command line:
+ $ make
+ The output should be "openssl-book.pdf".
diff --git a/introduction/about/about.tex b/introduction/about/about.tex
new file mode 100644
index 0000000..9ba0d80
--- /dev/null
+++ b/introduction/about/about.tex
@@ -0,0 +1,3 @@
+\chapter{About OpenSSL}
+\todo{Add some text here.}
diff --git a/openssl-book.tex b/openssl-book.tex
new file mode 100644
index 0000000..61dfba0
--- /dev/null
+++ b/openssl-book.tex
@@ -0,0 +1,40 @@
+\author{The OpenSSL Project}
+\title{The OpenSSL Guide}
+  breaklines=true,
+  frame=single,
+  xleftmargin=\parindent,
+  language=C,
+  showstringspaces=false,
+  basicstyle=\footnotesize\ttfamily,
+  numbers=left,
+  numberstyle=\tiny,
+  captionpos=b
+\part{OpenSSL on the Command Line}
+\part{SSL/TLS/DTLS Application Programming}
+\part{Cryptography Application Programming}

More information about the openssl-commits mailing list