summaryrefslogtreecommitdiffstats
path: root/packaging/makeself/README.md
diff options
context:
space:
mode:
authorPromise Akpan <akpanpromise@hotmail.com>2019-08-15 12:06:39 +0100
committerChris Akritidis <43294513+cakrit@users.noreply.github.com>2019-08-15 13:06:39 +0200
commitf5006d51e8caf9148d393eb68d53dc9fcd28b7b6 (patch)
tree03b757236d6b45e46813a4a875c77dc775e5f896 /packaging/makeself/README.md
parent69172fd57472df75d877f43de2dcc693c48ab5c0 (diff)
Fix Markdown Lint warnings (#6664)
* make remark access all directories * detailed fix after autofix by remark lint * cross check autofix for this set of files * crosscheck more files * crosschecking and small fixes * crosscheck autofixed md files
Diffstat (limited to 'packaging/makeself/README.md')
-rw-r--r--packaging/makeself/README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/packaging/makeself/README.md b/packaging/makeself/README.md
index cb6dde7c1d..b1dab7e0cb 100644
--- a/packaging/makeself/README.md
+++ b/packaging/makeself/README.md
@@ -3,16 +3,16 @@
To build the static binary 64-bit distribution package, run:
```bash
-$ cd /path/to/netdata.git
-$ ./packaging/makeself/build-x86_64-static.sh
+cd /path/to/netdata.git
+./packaging/makeself/build-x86_64-static.sh
```
The program will:
-1. setup a new docker container with Alpine Linux
-2. install the required alpine packages (the build environment, needed libraries, etc)
-3. download and compile third party apps that are packaged with Netdata (`bash`, `curl`, etc)
-4. compile Netdata
+1. setup a new docker container with Alpine Linux
+2. install the required alpine packages (the build environment, needed libraries, etc)
+3. download and compile third party apps that are packaged with Netdata (`bash`, `curl`, etc)
+4. compile Netdata
Once finished, a file named `netdata-vX.X.X-gGITHASH-x86_64-DATE-TIME.run` will be created in the current directory. This is the Netdata binary package that can be run to install Netdata on any other computer.
@@ -23,13 +23,13 @@ Once finished, a file named `netdata-vX.X.X-gGITHASH-x86_64-DATE-TIME.run` will
To build Netdata binaries with debugging / tracing information in them, use:
```bash
-$ cd /path/to/netdata.git
-$ ./packaging/makeself/build-x86_64-static.sh debug
+cd /path/to/netdata.git
+./packaging/makeself/build-x86_64-static.sh debug
```
These binaries are not optimized (they are a bit slower), they have certain features disables (like log flood protection), other features enables (like `debug flags`) and are not stripped (the binary files are bigger, since they now include source code tracing information).
-#### debugging Netdata binaries
+### debugging Netdata binaries
Once you have installed a binary package with debugging info, you will need to install `valgrind` and run this command to start Netdata:
@@ -45,4 +45,4 @@ To stop Netdata while it runs under `valgrind`, press Control-C on the console.
> If you omit the parameter `--undef-value-errors=no` to valgrind, you will get hundreds of errors about conditional jumps that depend on uninitialized values. This is normal. Valgrind has heuristics to prevent it from printing such errors for system libraries, but for the static Netdata binary, all the required libraries are built into Netdata. So, valgrind cannot appply its heuristics and prints them.
-[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fmakeself%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fmakeself%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)