Coding-Standards/coding_style_guide.tex at main · RISCY-Lib/Coding-Standards · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
\documentclass[12pt]{report}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Imports and formatting
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\input{./common/latex_packages.tex}
\input{./common/emphasis_boxes.tex}
\input{./common/code_listing_styles.tex}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Document Information
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\title{System Verilog Style Guide}
\author{Benjamin Davis, \href{mailto:allrisc.dev@gmail.com}{allrisc.dev@gmail.com}}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Header Footer Information
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\fancypagestyle{plain}{
  \fancyhf{}
  \fancyhead[R]{System Verilog Style Guide}
  \fancyfoot[L]{\copyright RISCY-Lib Contributors (under CC-BY-4.0)}
  \fancyfoot[R]{Page \thepage \ of \pageref{LastPage}}
}

\fancypagestyle{title}{
  \fancyhf{}
  \fancyhead[R]{System Verilog Style Guide}
  \fancyfoot[L]{\copyright RISCY-Lib Contributors (under CC-BY-4.0)}
}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Float Settings
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\renewcommand{\topfraction}{0.9}
\renewcommand{\bottomfraction}{0.8}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Start Document
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\begin{document}

  \pagestyle{title}
  \maketitle

  \newpage

  \vspace*{\fill}
  \begin{center}
    This work is licensed under \textbf{Creative Commons Attribution 4.0 International} (\texttt{CC-BY-4.0}).

    It is derived from the \href{https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md}{lowRISC Verilog Coding Style Guide}
      under the same license (as of Jan 21, 2022).

    The \texttt{lowRISC Verilog Coding Style Guide} has been modified in the following ways:
    \begin{itemize}
      \item Converted from Markdown to LaTeX
      \item Some underlying style recommendations have been changed
    \end{itemize}

    Subject to the above the work is \copyright RISCY-Lib Contributors, 2023
  \end{center}
  \vspace*{\fill}

  \pagestyle{plain}
  \tableofcontents

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  % Chapter 1 - Summary
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  \import{chapters/}{summary.tex}

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  % Chapter 2 - SystemVerilog Conventions
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  \import{chapters/}{systemverilog_conventions.tex}

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  % Chapter 3 - Naming
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  \import{chapters/}{naming.tex}

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  % Chapter 4 - Language Features
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  \import{chapters/}{language_features.tex}

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  % Chapter 5 - Design Conventions
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  \import{chapters/}{design_conventions.tex}

  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  % Appendices
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  \appendix

  \import{appendices/}{condensed_guide.tex}
  \import{appendices/}{basic_template.tex}

\end{document}