Skip to content

Commit 5c80226

Browse files
authored
docs: update readme (#90)
1 parent 545594a commit 5c80226

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ARG CLANG_VERSION
55

66
LABEL \
77
org.opencontainers.image.vendor="cpp-linter team" \
8-
org.opencontainers.image.title="Unofficial Clang Tools Docker image" \
8+
org.opencontainers.image.title="Clang Tools Docker image" \
99
org.opencontainers.image.description="The Clang Tools Docker image includes the clang-format and clang-tidy." \
1010
org.opencontainers.image.version="clang-tools:${CLANG_VERSION}" \
1111
org.opencontainers.image.url="https://hub.docker.com/r/xianpengshen/clang-tools" \

Dockerfile.all

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ FROM $BASE_IMAGE
33

44
LABEL \
55
org.opencontainers.image.vendor="cpp-linter team" \
6-
org.opencontainers.image.title="Unofficial Clang Tools Docker image" \
6+
org.opencontainers.image.title="Clang Tools Docker image" \
77
org.opencontainers.image.description="The Clang Tools Docker image includes the clang-format and clang-tidy." \
88
org.opencontainers.image.version="clang-tools:all" \
99
org.opencontainers.image.url="https://hub.docker.com/r/xianpengshen/clang-tools" \

Dockerfile.alpine

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ARG CLANG_VERSION
55

66
LABEL \
77
org.opencontainers.image.vendor="cpp-linter team" \
8-
org.opencontainers.image.title="Unofficial Clang Tools Docker image" \
8+
org.opencontainers.image.title="Clang Tools Docker image" \
99
org.opencontainers.image.description="The Clang Tools Docker image includes the clang-format and clang-tidy." \
1010
org.opencontainers.image.version="clang-tools:${CLANG_VERSION}" \
1111
org.opencontainers.image.url="https://hub.docker.com/r/xianpengshen/clang-tools" \

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,25 @@ You can access all available Clang Tools Docker images via [Docker Hub registry
3434

3535
```bash
3636
# Check clang-format version
37-
$ docker run xianpengshen/clang-tools:17 clang-format --version
38-
Ubuntu clang-format version 17.0.0 (+rc4-1~exp5ubuntu1)
37+
$ docker run xianpengshen/clang-tools:19 clang-format --version
38+
Ubuntu clang-format version 19.1.0 (1ubuntu1)
3939
# Format code (helloworld.c in the demo directory)
40-
$ docker run -v $PWD:/src xianpengshen/clang-tools:17 clang-format --dry-run -i helloworld.c
40+
$ docker run -v $PWD:/src xianpengshen/clang-tools:19 clang-format --dry-run -i helloworld.c
4141

4242
# Check clang-tidy version
43-
$ docker run xianpengshen/clang-tools:17 clang-tidy --version
44-
Ubuntu LLVM version 17.0.0
43+
$ docker run xianpengshen/clang-tools:19 clang-tidy --version
44+
Ubuntu LLVM version 19.1.0
4545
Optimized build.
4646

4747
# Diagnostic code (helloworld.c in the demo directory)
48-
$ docker run -v $PWD:/src xianpengshen/clang-tools:17 clang-tidy helloworld.c \
48+
$ docker run -v $PWD:/src xianpengshen/clang-tools:19 clang-tidy helloworld.c \
4949
-checks=boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-cplusplus-*,clang-analyzer-*,cppcoreguidelines-*
5050
```
5151

5252
### As base image in [`Dockerfile`](https://github.com/cpp-linter/clang-tools-docker/blob/master/demo/Dockerfile)
5353

5454
```Dockerfile
55-
FROM xianpengshen/clang-tools:17
55+
FROM xianpengshen/clang-tools:19
5656

5757
WORKDIR /src
5858

@@ -68,13 +68,13 @@ $ docker build -t clang-tools .
6868

6969
# Check clang-format version
7070
$ docker run clang-tools clang-format --version
71-
Ubuntu clang-format version 17.0.0 (+rc4-1~exp5ubuntu1)
71+
Ubuntu clang-format version 17.0.2 (1~exp1ubuntu2.1)
7272
# Format code
7373
$ docker run clang-tools clang-format --dry-run -i helloworld.c
7474

7575
# Check clang-tidy version
7676
$ docker run clang-tools clang-tidy --version
77-
Ubuntu LLVM version 17.0.0
77+
Ubuntu LLVM version 19.1.0
7878
Optimized build.
7979
# Diagnostic code
8080
$ docker run clang-tools clang-tidy helloworld.c \

0 commit comments

Comments
 (0)