Add GitHub label to _config.yml and change code links to use it

seladb · seladb · commit d1b4cfcd43ec · 2021-05-17T23:09:30.000-07:00
diff --git a/_config.yml b/_config.yml
@@ -27,7 +27,7 @@ top_navigation_enabled: true
 pcapplusplus_ver_num: 21.05
 pcapplusplus_ver: v21.05
 is_new_release: true
-
+github_label: v21.05
 # Google Analytics Tracking Id
 ga_tracking: UA-74037205-2
 
diff --git a/docs/community.md b/docs/community.md
@@ -55,4 +55,4 @@ If you already looked at the code and found the root cause - that's great! You c
 
 ### Code contributions
 
-If you'd like to fix bugs or add a new feature to PcapPlusPlus, please make sure to read the [CONTRIBUTING](https://github.com/seladb/PcapPlusPlus/blob/master/CONTRIBUTING.md) document. This document should provide you with all the necessary information on how to create the pull request, what it should include and how the review process works.
+If you'd like to fix bugs or add a new feature to PcapPlusPlus, please make sure to read the [CONTRIBUTING](https://github.com/seladb/PcapPlusPlus/blob/{{site.github_label}}/CONTRIBUTING.md) document. This document should provide you with all the necessary information on how to create the pull request, what it should include and how the review process works.
diff --git a/docs/dpdk.md b/docs/dpdk.md
@@ -197,4 +197,4 @@ If you're curious to learn more, please refer to the following resources:
 - [DPDK tutorial]({{ site.baseurl }}/docs/tutorials/dpdk)
 - DPDK example applications: [DpdkExample-FilterTraffic]({{ site.baseurl }}/docs/examples#dpdkexample-filtertraffic), [DpdkBridge]({{ site.baseurl }}/docs/examples#dpdkbridge), [KniPong]({{ site.baseurl }}/docs/examples#knipong)
 - DPDK API reference. A good starting points would be [`DpdkDevice.h` file description]({{ site.baseurl }}/api-docs/_dpdk_device_8h.html#details) and [`DpdkDevice` class description]({{ site.baseurl }}/api-docs/classpcpp_1_1_dpdk_device.html#details)
-- You can also find all the unit-tests in the [`Pcap++Test`](https://github.com/seladb/PcapPlusPlus/blob/master/Tests/Pcap%2B%2BTest/main.cpp) project (search for tests that contain "dpdk" or "kni")
+- You can also find all the unit-tests in the [`Pcap++Test`](https://github.com/seladb/PcapPlusPlus/blob/{{site.github_label}}/Tests/Pcap%2B%2BTest/main.cpp) project (search for tests that contain "dpdk" or "kni")
diff --git a/docs/examples.md b/docs/examples.md
@@ -16,78 +16,78 @@ PcapPlusPlus contains various example applications that make use of most PcapPlu
 1. TOC
 {:toc}
 
-## [ArpSpoofing](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/ArpSpoofing)
+## [ArpSpoofing](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/ArpSpoofing)
 
 an application that does ARP spoofing using Packet++ and Pcap++. You can read more about ARP spoofing [here](https://en.wikipedia.org/wiki/ARP_spoofing).
 
-## [Arping](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/Arping)
+## [Arping](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/Arping)
 
 an implementation of the [arping](https://en.wikipedia.org/wiki/Arping) utility using PcapPlusPlus.
 
-## [DnsSpoofing](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/DnsSpoofing)
+## [DnsSpoofing](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/DnsSpoofing)
 
 a command-line utility that does [DNS spoofing](https://en.wikipedia.org/wiki/DNS_spoofing) using Packet++ and Pcap++.
 
-## [DNSResolver](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/DNSResolver)
+## [DNSResolver](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/DNSResolver)
 
 a command-line utility that resolves IPv4 address for an hostname using ARP and DNS protocols.
 
-## [IcmpFileTransfer](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/IcmpFileTransfer)
+## [IcmpFileTransfer](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/IcmpFileTransfer)
 
 an application that demonstrates how to transfer files between two machines using only ICMP messages. The basic idea is to use the data part of ICMP messages to transfer chunks of the file between the machines. You can read more about it [here](http://www.unixist.com/security/data-transfer-over-icmp/index.html).
 
-## [HttpAnalyzer](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/HttpAnalyzer)
+## [HttpAnalyzer](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/HttpAnalyzer)
 
 an application that analyzes HTTP traffic and presents detailed and diverse information about it such as packet count and rate, bandwidth, flow count and rate, HTTP requests and responses count and rate, hostname histogram, content-type histogram, status code histogram and much more. Can operate on live traffic or read packets from a pcap file.
 
-## [SSLAnalyzer](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/SSLAnalyzer)
+## [SSLAnalyzer](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/SSLAnalyzer)
 
 an application that analyzes SSL/TLS traffic and presents detailed and diverse information about it such as packet count and rate, bandwidth, flow count and rate, SSL/TLS messages count, hostname histogram, SSL/TLS version count, cipher-suite count and much more. Can operate on live traffic or read packets from a pcap file.
 
-## [DpdkExample-FilterTraffic](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/DpdkExample-FilterTraffic)
+## [DpdkExample-FilterTraffic](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/DpdkExample-FilterTraffic)
 
 an application that demonstrates PcapPlusPlus DPDK APIs. This application listens to one or more DPDK ports (a.k.a DPDK devices), captures all traffic and matches packets by user-defined matching criteria such as source/dest IP, source/dest TCP/UDP port and more. Matched packets can be send to another DPDK port and/or be save to a pcap file. In addition the application collects statistics on received and matched packets.
 
-## [DpdkBridge](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/DpdkBridge)
+## [DpdkBridge](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/DpdkBridge)
 
 an application that demonstrates how to create a bridge between two network devices (similar to DPDK's L2 forwarding example) using PcapPlusPlus DPDK APIs.
 
-## [KniPong](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/KniPong)
+## [KniPong](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/KniPong)
 
 an application that demonstrates PcapPlusPlus wrapper for DPDK KNI. It emulates the Unix NETCAT utility run with -u key. It is basically a ping/pong client/server channel using user provided input from stdin.
 
-## [PfRingExample-FilterTraffic](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/PfRingExample-FilterTraffic)
+## [PfRingExample-FilterTraffic](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/PfRingExample-FilterTraffic)
 
 an application that demonstrates PcapPlusPlus PF_RING APIs. This application listens to a PF_RING interface, captures all traffic and matches packets by user-defined matching criteria such as source/dest IP, source/dest TCP/UDP port and more. Matched packets can be send to another PF_RING interface and/or be save to a pcap file. In addition the application collects statistics on received and matched packets.
 
-## [PcapPrinter](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/PcapPrinter)
+## [PcapPrinter](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/PcapPrinter)
 
 a simple application that outputs packets from a pcap file as a readable string.
 
-## [PcapSplitter](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/PcapSplitter)
+## [PcapSplitter](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/PcapSplitter)
 
 an application that splits pcap files into smaller pcap files by various criteria defined by the user like file size, packet count, split per connection, per client-ip, per server-ip, per server-port (protocol) or per IP src + IP dst (2-tuple). This application is very advanced compared to similar tools, for example: there is no limit on input file size or packet count, no technical limit on number of output files (unless the user sets a limit), support for both IPv4 and IPv6, and a lot more.
 
-## [PcapSearch](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/PcapSearch)
+## [PcapSearch](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/PcapSearch)
 
 an application that search inside pcap files in a directory/ies given by the user and counts how many packet match a user-defined pattern given in a BPF format.
 
-## [TcpReassembly](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/TcpReassembly)
+## [TcpReassembly](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/TcpReassembly)
 
 an application that captures data transmitted as part of TCP connections, organizes the data and stores it in a way that is convenient for protocol analysis and debugging. This application reconstructs the TCP data streams and stores each connection in a separate file(s). TcpReassembly understands TCP sequence numbers and will correctly reconstruct data streams regardless of retransmissions, out-of-order delivery or data loss.
 
-## [IPFragUtil](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/IPFragUtil)
+## [IPFragUtil](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/IPFragUtil)
 
 A utility for splitting IP packets into fragments. It works on pcap and pcapng files and allows the user to choose which packets to fragment and to which size. Works on IPv4 and IPv6 packets.
 
-## [IPDefragUtil](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/IPDefragUtil)
+## [IPDefragUtil](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/IPDefragUtil)
 
 A utility for reassembling IP fragments back to IP packets. It works on pcap and pcapng files and allows the user to choose which fragments to reassemble. Works on IPv4 and IPv6 packets.
 
-## [TLSFingerprinting](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/TLSFingerprinting)
+## [TLSFingerprinting](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/TLSFingerprinting)
 
 An application the demonstrates how to collect ClientHello (JA3) and ServerHello (JA3S) TLS fingerprints from live traffic or pcap files, write them to an output file and display various statistics.
 
-## [PcapPlusPlus-benchmark](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/PcapPlusPlus-benchmark)
+## [PcapPlusPlus-benchmark](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/PcapPlusPlus-benchmark)
 
 the benchmark application used for measuring PcapPlusPlus performance. See [benchmark page]({{ site.baseurl }}/docs/benchmark) for more details. This application currently compiles on Linux only (where benchmark was running on).
diff --git a/docs/features.md b/docs/features.md
@@ -261,7 +261,7 @@ printf("ClientHello (JA3) TLS fingerprint: '%s'; MD5: '%s'\n", tlsFingerprintStr
 
 ServerHello TLS fingerprinting (JA3S) is almost similar but for `pcpp::SSLServerHelloMessage` messages.
 
-To learn more please take a look at the [TLS fingerprinting example](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/TLSFingerprinting) in PcapPlusPlus GitHub repo which demonstrates how to collect ClientHello and ServerHello fingerprints from live traffic or pcap files, write them to an output file and display various statistics.
+To learn more please take a look at the [TLS fingerprinting example](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/TLSFingerprinting) in PcapPlusPlus GitHub repo which demonstrates how to collect ClientHello and ServerHello fingerprints from live traffic or pcap files, write them to an output file and display various statistics.
 
 ## Supported network protocols
 
diff --git a/docs/quickstart/macos.md b/docs/quickstart/macos.md
@@ -36,7 +36,7 @@ Another option is to build PcapPlusPlus [from source]({{ site.baseurl }}/docs/in
 
 ## Step 2 - create your first app
 
-If you installed PcapPlusPlus using Homebrew go to the [Hello World tutorial on GitHub](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/Tutorials/Tutorial-HelloWorld) and get the files in that directory.
+If you installed PcapPlusPlus using Homebrew go to the [Hello World tutorial on GitHub](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/Tutorials/Tutorial-HelloWorld) and get the files in that directory.
 
 If you downloaded a pre-compiled package go to: `/path/to/your/package/example-app`.
 
diff --git a/docs/tests.md b/docs/tests.md
@@ -82,7 +82,7 @@ After a successful build you can run these test-cases by following these simple
   Test cases: 92, Passed: 91, Failed: 1, Skipped: 0
   ```
 
-- Please note that it's very important to run the tests from the `Tests/Packet++Test` directory (using `Bin/Packet++Test`) because the test-cases are using packet examples that reside in [Tests/Packet++Test/PacketExamples](https://github.com/seladb/PcapPlusPlus/tree/master/Tests/Packet%2B%2BTest/PacketExamples) and are assuming the running directory is `Tests/Packet++Test`
+- Please note that it's very important to run the tests from the `Tests/Packet++Test` directory (using `Bin/Packet++Test`) because the test-cases are using packet examples that reside in [Tests/Packet++Test/PacketExamples](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Tests/Packet%2B%2BTest/PacketExamples) and are assuming the running directory is `Tests/Packet++Test`
 
 
 ### Some more technical details
@@ -275,7 +275,7 @@ After a successful build you can run these test-cases by following these simple
   ..
   ```
 
-- Please note that it's very important to run the tests from the `Tests/Pcap++Test` directory (using `Bin/Pcap++Test`) because the test-cases are using packet examples that reside in [Tests/Pcap++Test/PcapExamples](https://github.com/seladb/PcapPlusPlus/tree/master/Tests/Pcap%2B%2BTest/PcapExamples) and are assuming the running directory is `Tests/Pcap++Test`
+- Please note that it's very important to run the tests from the `Tests/Pcap++Test` directory (using `Bin/Pcap++Test`) because the test-cases are using packet examples that reside in [Tests/Pcap++Test/PcapExamples](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Tests/Pcap%2B%2BTest/PcapExamples) and are assuming the running directory is `Tests/Pcap++Test`
 
 - If you're building PcapPlusPlus with DPDK there is an additional mandatory command-line parameter which is "`-k`" or "`--dpdk-port`" where you need to provide the DPDK port to use for the tests. This port is simply a number starting from 0, so if you have only one interface assigned to DPDK the port number will be 0. If you have two interfaces assigned to DPDK then you can choose either 0 or 1, and so on. Please make sure there is network traffic flowing to this interface
 
@@ -366,7 +366,7 @@ Because this project is written in Python it has different requirements and setu
 ### Requirements
 
 - This project requires [Python 3.7](https://www.python.org/downloads/) or newer. It won't run on Python 2.7.x
-- It has dependencies on other Python libraries described in [`requirements.txt`](https://github.com/seladb/PcapPlusPlus/blob/master/Tests/ExamplesTest/requirements.txt). In the next section we'll go into the details of how to install them
+- It has dependencies on other Python libraries described in [`requirements.txt`](https://github.com/seladb/PcapPlusPlus/blob/{{site.github_label}}/Tests/ExamplesTest/requirements.txt). In the next section we'll go into the details of how to install them
 
 ### Setup
 
@@ -395,7 +395,7 @@ This section describes the steps to get to a working setup:
   seladb@seladb:~/PcapPlusPlus/Tests/ExamplesTest$ source venv/bin/activate
   (venv) seladbseladb:~/PcapPlusPlus/Tests/ExamplesTest$ 
   ```
-- Install the dependencies described in [`requirements.txt`](https://github.com/seladb/PcapPlusPlus/blob/master/Tests/ExamplesTest/requirements.txt):
+- Install the dependencies described in [`requirements.txt`](https://github.com/seladb/PcapPlusPlus/blob/{{site.github_label}}/Tests/ExamplesTest/requirements.txt):
 
   ```shell
   (venv) seladb@seladb:~/PcapPlusPlus/Tests/ExamplesTest$ python3 -m pip install -r requirements.txt
diff --git a/docs/tutorials/capture-packets.md b/docs/tutorials/capture-packets.md
@@ -492,7 +492,7 @@ As you can see the filter worked as there are no UDP, SSL or DNS packets, althou
 
 ## Running the example
 
-All code that was covered in this tutorial can be found [here](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/Tutorials/Tutorial-LiveTraffic). In order to compile and run the code please first download and compile PcapPlusPlus code or downloaded a pre-compiled version from the [{{ site.pcapplusplus_ver }} release](https://github.com/seladb/PcapPlusPlus/releases/tag/v21.05). Then follow these instruction, according to your platform:
+All code that was covered in this tutorial can be found [here](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/Tutorials/Tutorial-LiveTraffic). In order to compile and run the code please first download and compile PcapPlusPlus code or downloaded a pre-compiled version from the [{{ site.pcapplusplus_ver }} release](https://github.com/seladb/PcapPlusPlus/releases/tag/v21.05). Then follow these instruction, according to your platform:
 
 * Linux, MacOS, FreeBSD - make sure PcapPlusPlus is installed (by running **sudo make install** in PcapPlusPlus main directory). Then either change the `Makefile.non_windows` file name to `Makefile` and run `make all`, or run `make -f Makefile.non_windows all`
 * Windows using MinGW or MinGW-w64 - either change the `Makefile.windows` file name to `Makefile` and run `make all`, or run `make -f Makefile.windows all`
diff --git a/docs/tutorials/dpdk.md b/docs/tutorials/dpdk.md
@@ -402,7 +402,7 @@ This output is printed every 2 seconds and shows for each direction: the total n
 
 ## Running the example
 
-All the code that was covered in this tutorial can be found [here](https://github.com/seladb/PcapPlusPlus/tree/master/Examples/Tutorials/Tutorial-DpdkL2Fwd). In order to compile and run the code please first download and compile PcapPlusPlus source code or download a pre-compiled version from the [{{ site.pcapplusplus_ver }} release](https://github.com/seladb/PcapPlusPlus/releases/tag/v21.05). When building from source please make sure to configure the build for DPDK, as explained [here]({{ site.baseurl }}/docs/install/build-source/linux#command-line-switches-mode). The only platform relevant for this tutorial is Linux as DPDK is not supported on other platforms.
+All the code that was covered in this tutorial can be found [here](https://github.com/seladb/PcapPlusPlus/tree/{{site.github_label}}/Examples/Tutorials/Tutorial-DpdkL2Fwd). In order to compile and run the code please first download and compile PcapPlusPlus source code or download a pre-compiled version from the [{{ site.pcapplusplus_ver }} release](https://github.com/seladb/PcapPlusPlus/releases/tag/v21.05). When building from source please make sure to configure the build for DPDK, as explained [here]({{ site.baseurl }}/docs/install/build-source/linux#command-line-switches-mode). The only platform relevant for this tutorial is Linux as DPDK is not supported on other platforms.
 
 After done building PcapPlusPlus and the tutorial and before running the tutorial please run `setup-dpdk.sh` script to setup the necessary runtime parameters for DPDK. More details on this script can be found [here]({{ site.baseurl }}/docs/dpdk).
 
diff --git a/docs/tutorials/intro.md b/docs/tutorials/intro.md
diff --git a/docs/tutorials/packet-crafting.md b/docs/tutorials/packet-crafting.md
diff --git a/docs/tutorials/packet-parsing.md b/docs/tutorials/packet-parsing.md
diff --git a/docs/tutorials/read-write-pcap.md b/docs/tutorials/read-write-pcap.md

Original file line number	Diff line number	Diff line change
`@@ -55,4 +55,4 @@ If you already looked at the code and found the root cause - that's great! You c`
`55`	`55`
`56`	`56`	`### Code contributions`
`57`	`57`
`58`		`-If you'd like to fix bugs or add a new feature to PcapPlusPlus, please make sure to read the [CONTRIBUTING](https://github.com/seladb/PcapPlusPlus/blob/master/CONTRIBUTING.md) document. This document should provide you with all the necessary information on how to create the pull request, what it should include and how the review process works.`
	`58`	`+If you'd like to fix bugs or add a new feature to PcapPlusPlus, please make sure to read the [CONTRIBUTING](https://github.com/seladb/PcapPlusPlus/blob/{{site.github_label}}/CONTRIBUTING.md) document. This document should provide you with all the necessary information on how to create the pull request, what it should include and how the review process works.`