Skip to content

Use ARG for LLVM_VERSION; update README #100

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.

Sign up for GitHub

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

Open
sean-parent wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −10
Open

Use ARG for LLVM_VERSION; update README #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ RUN apt-get -y install build-essential

# FROM base AS full

ENV LLVM_VERSION=15
ARG LLVM_VERSION=15

RUN apt-get -y install clang-${LLVM_VERSION}
RUN apt-get -y install libc++-${LLVM_VERSION}-dev
Expand Down
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
## macOS

- Homebrew
- `brew install cmake`
- `brew install ninja` (optional)
- `brew install cmake`
- `brew install ninja` (optional)

## Linux

(Note: only tested on ubuntu bionic so far)

- Apt
- `sudo apt-get install libyaml-cpp-dev`
- `sudo apt-get install libyaml-cpp-dev`

# How to Build

Expand All @@ -41,6 +41,10 @@ LLVM/Clang are declared as a dependency in the project's `CMakeLists.txt` file,

# How to run from Docker

Login to [GitHub Packages registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic)

Fetch the latest image and run it:

```sh
docker pull ghcr.io/adobe/hyde:latest

Expand All @@ -53,10 +57,10 @@ You can then run the examples as below, except don't prefix `hyde` with `./`.

# Building the Docker image

You may need to increase your docker resources to build the image. (2.0.1 successfully built with 16GB RAM and 4GB swap)
You may need to increase your docker resources to build the image. On machines with limited RAM you may be able to get away with less, and a swap file.

```sh
docker build --tag hyde .
docker build --memory="16g" --memory-swap="32g" --build-arg LLVM_VERSION=18 --tag hyde .

docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)",target=/mnt/host \
--tty --interactive \
Expand All @@ -76,7 +80,6 @@ docker push ghcr.io/adobe/hyde:$VERSION
docker push ghcr.io/adobe/hyde:latest
```


# Parameters and Flags

There are several modes under which the tool can run:
Expand All @@ -103,13 +106,13 @@ While compiling the source file, the non-function macro `ADOBE_TOOL_HYDE` is def
# Examples:

To output JSON:
```./hyde -use-system-clang ../test_files/classes.cpp --```
`./hyde -use-system-clang ../test_files/classes.cpp --`

To validate pre-existing YAML:
```./hyde -use-system-clang -hyde-yaml-dir=/path/to/output -hyde-validate ../test_files/classes.cpp```
`./hyde -use-system-clang -hyde-yaml-dir=/path/to/output -hyde-validate ../test_files/classes.cpp`

To output updated YAML:
```./hyde -use-system-clang -hyde-yaml-dir=/path/to/output -hyde-update ../test_files/classes.cpp```
`./hyde -use-system-clang -hyde-yaml-dir=/path/to/output -hyde-update ../test_files/classes.cpp`

# Hyde 1 to Hyde 2 Format Conversion

Expand Down