Skip to content

Commit

Permalink
minor updates per comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Lisa Delaney committed Nov 22, 2023
1 parent 601cba2 commit 0548e5a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Changelog for HIPIFY

Documentation for HIPIFY is available at
[[HIPIFY documentation](https://rocmdocs.amd.com/projects/HIPIFY/en/latest/)](https://rocmdocs.amd.com/projects/HIPIFY/en/latest/).
[https://rocmdocs.amd.com/projects/HIPIFY/en/latest/](https://rocmdocs.amd.com/projects/HIPIFY/en/latest/).

## HIPIFY for ROCm 6.0.0

Expand Down Expand Up @@ -32,7 +32,7 @@ Documentation for HIPIFY is available at
* In one file: `hipify-clang --md --doc-format=full --doc-roc=joint`
* New options:
* `--use-hip-data-types` (Use 'hipDataType' instead of 'hipblasDatatype_t' or 'rocblas_datatype')
* `--doc-roc=\<value\>` (ROC documentation generation: `skip` (default), `separate`, and `joint`; the
* `--doc-roc=\<value\>` (ROC documentation generation: `skip` (default), `separate`, and `joint`; the
`--md` or `--csv` option must be included)

### Known issues
Expand All @@ -56,7 +56,7 @@ Documentation for HIPIFY is available at
### Fixes

* Accessing `half2 struct` members (undocumented feature)
* Moved `INSTALL` to the `bin` subfolder
* Retargeted `INSTALL` to the `bin` subfolder

## HIPIFY for ROCm 5.5.0

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,14 @@ HIPIFY is a set of tools that you can use to automatically translate CUDA source
* Related: [hipify_torch](https://github.com/ROCmSoftwarePlatform/hipify_torch)
* [Supported CUDA APIs](./docs/supported_apis.md#supported-cuda-apis)
* [Documentation](#documentation)
* [How to build HIPIFY documentation](#how-to-build-hipify-documentation)
* [How to build CUDA2HIP documentation](#how-to-build-cuda2hip-documentation)
* [Disclaimer](#disclaimer)

<!-- tocstop -->

## Documentation

Documentation for HIPIFY is available at
[[HIPIFY documentation](https://rocmdocs.amd.com/projects/HIPIFY/en/latest/)](https://rocmdocs.amd.com/projects/HIPIFY/en/latest/).
[https://rocmdocs.amd.com/projects/HIPIFY/en/latest/](https://rocmdocs.amd.com/projects/HIPIFY/en/latest/).

To build our documentation locally, run the following code.

Expand All @@ -46,7 +44,11 @@ command. This builds the same content as
[Supported CUDA APIs](./docs/supported_apis.md#supported-cuda-apis).

```bash
hipify-clang --md --doc-format=full
hipify-clang --md --doc-format=full --doc-roc=joint

# Alternatively, you can use:

hipify-clang --md --doc-format=full --doc-roc=separate
```

To generate this documentation in CSV, use the `--csv` option instead of `--md`. Instead of using
Expand Down

0 comments on commit 0548e5a

Please sign in to comment.