search

kubernetes-client / c

Official C client library for Kubernetes
Apache License 2.0
146 stars 45 forks source link

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

Closed rexlim820220 closed 1 year ago

rexlim820220 commented 1 year ago

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

linux-foundation-easycla[bot] commented 1 year ago

CLA Signed

The committers listed above are authorized under a signed CLA.

k8s-ci-robot commented 1 year ago

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. :smiley:

ityuhui commented 1 year ago

Thank you @rexlim820220

Can you please follow the guidelines to sign CLA ?

rexlim820220 commented 1 year ago

＠ity

Thank you @rexlim820220

Can you please follow the guidelines to sign CLA ?

will be spending time figuring it out, thanks

ityuhui commented 1 year ago

/lgtm /approve

k8s-ci-robot commented 1 year ago

[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: - ~~[OWNERS](https://github.com/kubernetes-client/c/blob/master/OWNERS)~~ [ityuhui] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment