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

[DOC] Installation instruction incomplete #568

Open
b1llab0ng opened this issue Oct 17, 2019 · 4 comments
Open

[DOC] Installation instruction incomplete #568

b1llab0ng opened this issue Oct 17, 2019 · 4 comments

Comments

@b1llab0ng
Copy link

Describe the bug
Installation instructions in README.md file and on the Download and installation web page are outdated. Missing coverage for autogen.sh script.

To Reproduce
Steps to reproduce the behavior:

  1. GIT Clone fresh Master source in a new empty folder
  2. Attempt to execute ./configure per installation instructions fails, file not found (without prior executing autogen.sh script, as not mentioned in instructions, the configure file does not exist yet).

Expected behavior
Installation instructions expected to be complete from fresh GIT cloned copy.
Installation instructions to be updated to add prior to execute ./configure, the step to execute the autogen.sh script in order to get the necessary configure script file.

Screenshots
See * mark below:
Missing autogen coverage

System (please complete the following information):

  • OS: Debian
  • OS version: 4.9.189-3 (2019-09-02) x86_64 GNU/Linux
  • Tcpreplay Version 4.3.2 (build git:v4.3.2-2-ga00fd476)

Additional context
N/A

@fklassen
Copy link
Member

You are missing the Donwloads step in the doc. Release tarballs have ./configure script.

The configure script is not included in the source code, as is common practise. Proper generation of the script requires autogen which is very version dependent. Developers create releases with sudo make test && make dist. Regular users use releases.

@b1llab0ng
Copy link
Author

Ok. I further read the instructions and figured it out. It's true that the tar ball contains the configure file.
I intermingled the download instructions for developer cloning from GIT and followed simple installation instructions for std user, leading to why I opened this ticket at first.
Although, perhaps it would be a good addition for complementing instructions, to provide the installation instructions for when cloning from GIT; then prior running the autogen.sh script is necessary for obtaining the ./configure.

@fklassen fklassen added this to the 4.3.3 milestone Oct 18, 2019
@fklassen
Copy link
Member

Point taken. Will target next fix release.

@b1llab0ng
Copy link
Author

Thank you

@fklassen fklassen added this to To do in 4.4 via automation Jun 3, 2020
@fklassen fklassen removed this from the 4.3.3 milestone Jun 3, 2020
@fklassen fklassen removed this from To do in 4.4 Jan 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants