Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small fixes for documentation #657

Merged
merged 5 commits into from
Mar 31, 2021
Merged

Small fixes for documentation #657

merged 5 commits into from
Mar 31, 2021

Conversation

grantseltzer
Copy link
Contributor

This handles #652

Signed-off-by: grantseltzer <grantseltzer@gmail.com>
… usage accordingly

Signed-off-by: grantseltzer <grantseltzer@gmail.com>
Signed-off-by: grantseltzer <grantseltzer@gmail.com>
Signed-off-by: grantseltzer <grantseltzer@gmail.com>
@grantseltzer grantseltzer linked an issue Mar 30, 2021 that may be closed by this pull request
5 tasks
docs/config.md Outdated Show resolved Hide resolved
Comment on lines -29 to +30
logo: images/tracee.png
logo: images/tracee_logo_only.png
Copy link
Member

@simar7 simar7 Mar 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Seems like we have two asset sources now, one under docs/images/ and one under images/ could we reconcile them somehow?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR removes the images/ directory for the base of the repo completely. This particular line is referencing the one in docs/images/

Signed-off-by: grantseltzer <grantseltzer@gmail.com>
@grantseltzer grantseltzer merged commit 69b576e into main Mar 31, 2021
@grantseltzer grantseltzer deleted the docs-small-fixes branch March 31, 2021 02:34
@@ -1,19 +1,19 @@
# Prerequisites

- Linux kernel version >= 4.18
- Linux kernel headers available under conventional location (see [Linux Headers](#TODO) section for more info)
- libc, and the libraries: libelf, zlib
Copy link
Collaborator

@itaysk itaysk Mar 31, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

libbpf is not a prerequisite (the the user)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@itaysk are you saying that because we package libbpf source code with this repo?

Would all these library prerequisites be eliminated if we statically compile our releases? And headers once I finish with CO:RE?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if someone wants to run tracee, they can download the binary, and run it, they don't need to have libbpf in order for tracee to run, right? the same can't be said for libelf, zlib which are required at runtime.

Yes I think if we statically compile tracee those reqs would be eliminated

@itaysk itaysk mentioned this pull request Mar 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix documentation content issues
3 participants