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

fix([README.md]): typos in README.md causes installation error #186

Merged
merged 1 commit into from
May 4, 2023

Conversation

rexlim820220
Copy link
Contributor

Summary

The following description in README.md might causes ambiguous parsing during cmake code building:

cmake -DLWS_WITHOUT_TESTAPPS=ON -DLWS_WITHOUT_TEST_SERVER=ON-DLWS_WITHOUT_TEST_SERVER_EXTPOLL=ON.

What is the behavior?

While copying above commands to Dockerfile, error was encountered.

The code is built in Docker under CentOS Linux release 7.7.1908 (Core) with cmake version 3.6.2.

Dockerfile:3
--------------------
   2 |     ADD cbrs /opt/app
  17 | >>>     RUN cd /opt/app/ && \
  18 | >>>     # Install pre-requisites
  19 | >>>     yum install -y openssl-devel libcurl-devel uncrustify && \
  20 | >>>     # Build pre-requisite: libwebsockets
  21 | >>>     git clone https://libwebsockets.org/repo/libwebsockets --depth 1 --branch v4.2-stable && \
  22 | >>>     cd libwebsockets && mkdir build && cd build && \
  23 | >>>     cmake -DLWS_WITHOUT_TESTAPPS=ON -DLWS_WITHOUT_TEST_SERVER=ON-DLWS_WITHOUT_TEST_SERVER_EXTPOLL=ON \
  24 | >>>        -DLWS_WITHOUT_TEST_PING=ON -DLWS_WITHOUT_TEST_CLIENT=ON -DCMAKE_C_FLAGS="-fpic" -DCMAKE_INSTALL_PREFIX=/usr/local ..
--------------------
ERROR: failed to solve: process "/bin/sh -c cd /opt/app/ &&     yum install -y libssl-dev libcurl4-openssl-dev uncrustify &&     git clone https://libwebsockets.org/repo/libwebsockets --depth 1 --branch v4.2-stable &&     cd libwebsockets && mkdir build && cd build &&     cmake -DLWS_WITHOUT_TESTAPPS=ON        -DLWS_WITHOUT_TEST_SERVER=ON-DLWS_WITHOUT_TEST_SERVER_EXTPOLL=ON        -DLWS_WITHOUT_TEST_PING=ON        -DLWS_WITHOUT_TEST_CLIENT=ON        -DCMAKE_C_FLAGS=\"-fpic\" .." did not complete successfully: exit code: 1
ERROR: Service 'app' failed to build

Advise

A maybe nicer description would be splitting -D from SERVER=ON, which makes the command less ambiguous.

/label ~bug ~reproduced ~needs-investigation

The following description in README.md might causes ambiguous parsing during cmake code building:

cmake -DLWS_WITHOUT_TESTAPPS=ON -DLWS_WITHOUT_TEST_SERVER=ON-DLWS_WITHOUT_TEST_SERVER_EXTPOLL=ON.

split -D from SERVER=ON
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 3, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: rexlim820220 / name: Pisces Zhang (2ab0573)

@k8s-ci-robot k8s-ci-robot requested a review from ityuhui May 3, 2023 03:22
@k8s-ci-robot
Copy link
Contributor

Welcome @rexlim820220!

It looks like this is your first PR to kubernetes-client/c 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/c has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 3, 2023
@ityuhui
Copy link
Member

ityuhui commented May 3, 2023

Thank you @rexlim820220

Can you please follow the guidelines to sign CLA ?

@rexlim820220
Copy link
Contributor Author

@ity

Thank you @rexlim820220

Can you please follow the guidelines to sign CLA ?

will be spending time figuring it out, thanks

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels May 3, 2023
@ityuhui
Copy link
Member

ityuhui commented May 4, 2023

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 4, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ityuhui, rexlim820220

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 4, 2023
@k8s-ci-robot k8s-ci-robot merged commit 6a82bde into kubernetes-client:master May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants