From: Max Value Date: Sat, 29 Mar 2025 00:46:54 +0000 (+0000) Subject: Added section on git X-Git-Url: https://git.ozva.co.uk/?a=commitdiff_plain;h=fe359e2214286945e4a0cc2ff2bd8d17fcd483ca;p=shopping-docs Added section on git This references itelf! omg! --- diff --git a/chapters/tech.tex b/chapters/tech.tex index 924756d..fac67ae 100644 --- a/chapters/tech.tex +++ b/chapters/tech.tex @@ -2,4 +2,5 @@ \textsc{In which} we discuss the systems built for XMDV Teleshopping. +\input{sections/git} \input{sections/clock} diff --git a/main.sty b/main.sty index 27e6b97..687e50f 100644 --- a/main.sty +++ b/main.sty @@ -52,6 +52,11 @@ % ==================== % MACROS +\newcommand{\repo}[1]{ + \href{https://git.ozva.co.uk/?p=#1} + {\texttt{OzVa Repo "#1"}} + } + \newcommand{\commit}[2]{ \href{https://git.ozva.co.uk/?p=#1;a=commit;h=#2} {\texttt{OzVa Commit \StrLeft{#2}{7}}} diff --git a/sections/git.tex b/sections/git.tex new file mode 100644 index 0000000..e9c5a2b --- /dev/null +++ b/sections/git.tex @@ -0,0 +1,15 @@ +\section{``Git'' and version control} + +\subsection{Background} + +``Git'' is a version control system designed for the development of the linux kernel in 2005. It is \textit{extreamly} widly used. So much so that knowlage of it is considered pre-requisite in the computer science sector. It is not to be confused with GitHub\footnote{GitHub is a web front end but it is so commonly used that some forget that ``Git'' is actually just a command line utility.}. Naturally, I have been tracking everything with it for the last year, inluding running my own Git server. + +Tracked folders are called ``repositaries'' or ``repos'' and contain not just the current state of the program, but the entire history back to when tracking began. + +When you make a change you ``commit'' it, along with a message describing what you did. This is then ``pushed'' to some central repo if this exists. Occasionally throughout this document I'll be mentioning certain commits or repos, these are all to do with the version control. + +\subsection{Tracking} + +You can take a look at the \textit{entire} history of this document right back to the first word (\repo{shopping-docs}), the code that makes the clock tick (\repo{doomsday-clock}) and the hundreds of commits that make up the GFX overlay (\repo{shopping-channel}). Everything can be accessed on \url{https://git.ozva.co.uk}. For example, this document was pushed to (\repo{shopping-channel}) in \commit{shopping-docs}{7453e4d7bbb9e0f11c4de992a7755550ddd413a9}, take a look at the message attached. + +Admittedly, the tracking on the docs is poor, they tell their own story. But the tracking on the GFX overlay is robust and has proven useful for development.