Skip to contentSkip to conversation

Added building instructions to README.md

PATCH Superseded Yoni Bettan 2 participants 5 messages Aug 13, 2019 1 message not in the archive

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v3 cover Added building instructions to README.md

V2 -> V3:

- Changed the fonts to liberation fonts
- Added building instruction for OSX user

V1 -> V2:

- Added building instructions to README.md

Yoni Bettan (2):
Changed fonts to fonts available with tex-live.
README.md: Added building instructions.

 README.md        | 39 +++++++++++++++++++++++++++++++++++++++
 commands-pdf.tex | 12 ++++++------
 virtio.tex       |  6 +++---
 3 files changed, 48 insertions(+), 9 deletions(-)
Signature · 18 lines
2.21.0


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/
#1 lore raw

PATCH v3 1/2 Changed fonts to fonts available with tex-live.

Arial -> Liberation Sans
Courier New -> Liberation Mono

There small visual difference but 'Arial' and 'Courier New' are not installed in TeX Live therefore this change eliminates the errors created while compiling the project using 'makeall.sh'.

---
 commands-pdf.tex | 12 ++++++------
 virtio.tex       |  6 +++---
 2 files changed, 9 insertions(+), 9 deletions(-)
commands-pdf.tex +6 -6
index ae7a186..d0612e8 100644
@@ -20,7 +20,7 @@
 \newcommand{\oasistitle}[1]
 {
 \begin{spacing}{1.5}
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{24}{24}
 \textbf{\noindent#1}
 \end{spacing}
@@ -29,7 +29,7 @@
 \newcommand{\oasisstagelabel}[1]
 {
 \begin{spacing}{1.1}
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -38,7 +38,7 @@
 \newcommand{\oasisdate}[1]
 {
 \begin{spacing}{1.1}
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -47,7 +47,7 @@
 \newcommand{\oasisnoticelabel}[1]
 {
 \begin{spacing}{1.5}
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -56,7 +56,7 @@
 \newcommand{\oasisspecificationuris}[1]
 {
 {
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{12}{12}
 \textbf{\noindent#1}
 }
@@ -65,7 +65,7 @@
 \newenvironment{oasistitlesection}[1]
 {
 \setlength{\tabcolsep}{0in}\begin{tabular}{p{0in}p{5.8in}}
-\multicolumn{2}{l}{\fontspec[Color=446CAA]{Arial}\fontsize{10}{10}\textbf{#1:}}\\[-0.05in]
+\multicolumn{2}{l}{\fontspec[Color=446CAA]{Liberation Sans}\fontsize{10}{10}\textbf{#1:}}\\[-0.05in]
 &\setlength{\topsep}{0in}\setlength{\parsep}{0in}\setlength{\partopsep}{0in}   }
 {
 \end{tabular}
virtio.tex +3 -3
index ef2d3fe..e7c7b53 100644
@@ -52,9 +52,9 @@
 %\def_{\_}
 % Don't hyphenate acronyms
 %\uchyph=0
-\setmainfont[Mapping=tex-text]{Arial}
-%\setromanfont{Arial}
-\setmonofont{Courier New}
+\setmainfont[Mapping=tex-text]{Liberation Sans}
+%\setromanfont{Liberation Sans}
+\setmonofont{Liberation Mono}
 
 \urlstyle{rm}
 
Signature · 18 lines
2.21.0


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/
#2 lore raw

[virtio-comment] Re: [PATCH V3 1/2] Changed fonts to fonts available with tex-live.

Chet, please see below.

Documents from
http://docs.oasis-open.org/templates/OASISSpecificationTemplateGuidelinesV4.0.html
all use microsoft fonts such as Arial.

E.g. this can be seen in the PDFs on that site.

How important is the use of the specific fonts for consistency?

Thanks!

Quoted 8 lines · Yoni Bettan

Arial -> Liberation Sans
Courier New -> Liberation Mono

There small visual difference but 'Arial' and 'Courier New' are not installed in TeX Live therefore this change eliminates the errors created while compiling the project using 'makeall.sh'.

Yep, you need to get these fonts separately. But I don't think we can change the fonts, these are recommended OASIS fonts, see
http://docs.oasis-open.org/templates/OASISSpecificationTemplateGuidelinesV4.0.html

Quoted 82 lines
---
 commands-pdf.tex | 12 ++++++------
 virtio.tex       |  6 +++---
 2 files changed, 9 insertions(+), 9 deletions(-)
commands-pdf.tex +6 -6
index ae7a186..d0612e8 100644
@@ -20,7 +20,7 @@
 \newcommand{\oasistitle}[1]
 {
 \begin{spacing}{1.5}
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{24}{24}
 \textbf{\noindent#1}
 \end{spacing}
@@ -29,7 +29,7 @@
 \newcommand{\oasisstagelabel}[1]
 {
 \begin{spacing}{1.1}
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -38,7 +38,7 @@
 \newcommand{\oasisdate}[1]
 {
 \begin{spacing}{1.1}
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -47,7 +47,7 @@
 \newcommand{\oasisnoticelabel}[1]
 {
 \begin{spacing}{1.5}
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{18}{18}
 \textbf{\noindent#1}
 \end{spacing}
@@ -56,7 +56,7 @@
 \newcommand{\oasisspecificationuris}[1]
 {
 {
-\fontspec[Color=446CAA]{Arial}
+\fontspec[Color=446CAA]{Liberation Sans}
 \fontsize{12}{12}
 \textbf{\noindent#1}
 }
@@ -65,7 +65,7 @@
 \newenvironment{oasistitlesection}[1]
 {
 \setlength{\tabcolsep}{0in}\begin{tabular}{p{0in}p{5.8in}}
-\multicolumn{2}{l}{\fontspec[Color=446CAA]{Arial}\fontsize{10}{10}\textbf{#1:}}\\[-0.05in]
+\multicolumn{2}{l}{\fontspec[Color=446CAA]{Liberation Sans}\fontsize{10}{10}\textbf{#1:}}\\[-0.05in]
 &\setlength{\topsep}{0in}\setlength{\parsep}{0in}\setlength{\partopsep}{0in}   }
 {
 \end{tabular}
virtio.tex +3 -3
index ef2d3fe..e7c7b53 100644
@@ -52,9 +52,9 @@
 %\def_{\_}
 % Don't hyphenate acronyms
 %\uchyph=0
-\setmainfont[Mapping=tex-text]{Arial}
-%\setromanfont{Arial}
-\setmonofont{Courier New}
+\setmainfont[Mapping=tex-text]{Liberation Sans}
+%\setromanfont{Liberation Sans}
+\setmonofont{Liberation Mono}
 
 \urlstyle{rm}
 
Signature · 1 line
2.21.0

This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

A message that is not in the archive (sent off-list or not yet received): CAJSP0QU8yR+TekJLyqrTS-ukSjGMJ0zmi7W3yT_tYGOO5opknA@mail.gmail.com

#4 lore raw

[virtio-comment] Re: [PATCH V3 1/2] Changed fonts to fonts available with tex-live.

Quoted 7 lines · Stefan Hajnoczi
Quoted 6 lines · Michael S. Tsirkin

Chet, please see below.

Documents from
http://docs.oasis-open.org/templates/OASISSpecificationTemplateGuidelinesV4.0.html
all use microsoft fonts such as Arial.

Quoted 8 lines
Quoted 3 lines

E.g. this can be seen in the PDFs on that site.

How important is the use of the specific fonts for consistency?

If the fonts cannot be changed in the official release of the spec, can we automatically detect their availability at build time so Liberation Sans fonts are used on machines without Microsoft fonts installed? This way local builds use free fonts and the official releases continue to use the Microsoft fonts.

I think this is possible, this will required to change makeall.sh to determine if the machine runs Linux or other OS and according to it updates the fonts locally for Linux machines.

I will try it and send another version for this patch.

Quoted 2 lines

Stefan

This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

#5 lore raw

PATCH v3 2/2 README.md: Added building instructions.

In reply to Yoni Bettan
---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
README.md +39 -0
index 4747824..d9f2d36 100644
@@ -29,6 +29,45 @@
 <div>
 
 <h3>Further Description of this Repository</h3>
+<h4>Building Instructions</h4>
+<p>In order to build the spec you will need <a href="https://www.tug.org/texlive/">Tex-Live</a>.
+Installing it can be done via:<br>
+Fedora:
+<code>
+sudo dnf install texlive-scheme-full
+</code><br>
+Ubuntu:
+<code>
+sudo apt-get install texlive-full
+</code><br></p>
+<p>OSX users don't need to install Tex-Live because they already have <a href="http://www.tug.org/mactex/">MacTex</a> installed but they need to install liberation-fonts in order to compile:
+  
+<ol>
+<li>
+download latest version of <a href="https://releases.pagure.org/liberation-fonts/">liberation-fonts</a>
+</li>
+<li>
+unzip it
+</li>
+<li>
+install all 'LiberationSans' and 'LiberationMono' fonts by duble clicking on there .tty files
+</li>
+</ol>
+  
+<p>The building proccess is done with
+<code>
+./makeall.sh
+</code>
+and it contains 3 main parts:
+<code>
+makezip.sh
+</code>,
+<code>
+makehtml.sh
+</code>,
+<code>
+makepdf.sh
+</code>.
 <h4>Providing Feedback</h4>
 Feedback must be provided the <strong>virtio-comment</strong> mailing list,
 and archived in the mailing list archives.
Signature · 18 lines
2.21.0


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/