From 73073b527fc4bf457a477fd08d7d5db94ec0c9ce Mon Sep 17 00:00:00 2001
From: Cem Keylan <cem@ckyln.com>
Date: Mon, 21 Sep 2020 22:14:48 +0300
Subject: Add comment lines for the better visualizing of the file edited

---
 contribution.texi | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

(limited to 'contribution.texi')

diff --git a/contribution.texi b/contribution.texi
index e7e776c..ad685af 100644
--- a/contribution.texi
+++ b/contribution.texi
@@ -1,3 +1,9 @@
+@c This document is part of Carbs Linux Documentation.
+@c See the top.texi file for LICENSE information.
+
+@c -----------------------------------------------------------------------------
+
+@c Macro Definitions
 @macro contid{id}
 [@anchor{\id\}\id\]
 @end macro
@@ -6,6 +12,9 @@
 @strong{@contid{\id\} \sect\}
 @end macro
 
+
+@c -----------------------------------------------------------------------------
+
 @node Contribution Guidelines
 @chapter Contribution Guidelines
 
@@ -18,9 +27,21 @@ and changes may occur with good reasoning.
 * Sending Git mails::
 @end menu
 
+
+@c -----------------------------------------------------------------------------
+
 @node Conventions
 @section Conventions
 
+@menu
+* General Conventions::
+* Shell Conventions::
+* Repository Conventions::
+@end menu
+
+
+@c -----------------------------------------------------------------------------
+
 @node General Conventions
 @subsection General Conventions -- 00
 
@@ -45,6 +66,9 @@ your code goes here  # Avoid this way of commenting.
 @end table
 @end table
 
+
+@c -----------------------------------------------------------------------------
+
 @node Shell Conventions
 @subsection Shell Conventions -- 10
 
@@ -82,6 +106,9 @@ test
 Instead of backticks, use @verb{|$(..)|}.
 @end table
 
+
+@c -----------------------------------------------------------------------------
+
 @node Repository Conventions
 @subsection Repository Conventions -- 20
 
@@ -136,6 +163,9 @@ The next section is about package templates that should be used in order to
 ensure stylistic consistency. Note that the option configurations shouldn't be
 taken literally, they are meant as examples.
 
+
+@c -----------------------------------------------------------------------------
+
 @sectid{2210, Make}
 
 @example
@@ -145,6 +175,9 @@ make
 make DESTDIR="$1" PREFIX=/usr install
 @end example
 
+
+@c -----------------------------------------------------------------------------
+
 @sectid{2211, Configure/Make}
 
 @example
@@ -160,6 +193,8 @@ make DESTDIR="$1" install
 @end example
 
 
+@c -----------------------------------------------------------------------------
+
 @sectid{2212, Autoconf/Automake}
 
 @xref{2020}
@@ -178,6 +213,9 @@ make
 make DESTDIR="$1" install
 @end example
 
+
+@c -----------------------------------------------------------------------------
+
 @sectid{2220, Meson}
 
 @example
@@ -195,6 +233,9 @@ ninja -C output
 ninja -C output install
 @end example
 
+
+@c -----------------------------------------------------------------------------
+
 @sectid{2230, Cmake}
 
 @example
@@ -211,6 +252,9 @@ cmake --build   build
 cmake --install build
 @end example
 
+
+@c -----------------------------------------------------------------------------
+
 @sectid{2240, Go}
 
 @example
@@ -224,6 +268,9 @@ go build
 install -Dm755 program "$1/usr/bin/program"
 @end example
 
+
+@c -----------------------------------------------------------------------------
+
 @sectid{2241, Python}
 
 @example
@@ -233,6 +280,9 @@ python setup.py build
 python setup.py install --prefix=/usr --root="$1"
 @end example
 
+
+@c -----------------------------------------------------------------------------
+
 @node Sending Git mails
 @section Sending Git mails
 
@@ -277,3 +327,6 @@ $ git format-patch --to=~carbslinux/dev+subscribe@@lists.sr.ht <region>
 Edit those files as necessary and send them.
 $ for file in *.patch; do msmtp -t -a my-mail < $patch; done
 @end example
+
+
+@c -----------------------------------------------------------------------------
-- 
cgit v1.2.3