From 58eef8b9ffd827e71cb1524f15a6a225763c12ec Mon Sep 17 00:00:00 2001 From: Radu Mereuta Date: Thu, 12 Oct 2023 16:42:36 +0300 Subject: [PATCH] Move README from builtin (#3701) to avoid name collision Fixes: #3695 @yiyi-wang-rv can you review this? I want to make sure we're not going to break the website links. Co-authored-by: rv-jenkins --- .../include/kframework/{builtin => }/README.md | 14 +++++++------- web/toc.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) rename k-distribution/include/kframework/{builtin => }/README.md (55%) diff --git a/k-distribution/include/kframework/builtin/README.md b/k-distribution/include/kframework/README.md similarity index 55% rename from k-distribution/include/kframework/builtin/README.md rename to k-distribution/include/kframework/README.md index 047f612b914..cee97c1a869 100644 --- a/k-distribution/include/kframework/builtin/README.md +++ b/k-distribution/include/kframework/README.md @@ -11,14 +11,14 @@ simpler. These files can be found under `include/kframework/builtin` in your K installation directory, and can be imported with `requires "FILENAME"` (without the path prefix). -- [domains](domains.md): Basic datatypes which are universally useful. -- [kast](kast.md): Representation of K internal data-structures (not to be +- [domains](builtin/domains.md): Basic datatypes which are universally useful. +- [kast](builtin/kast.md): Representation of K internal data-structures (not to be included in normal definitions). -- [prelude](prelude.md): Automatically included into every K definition. -- [ffi](ffi.md): FFI interface for calling out to native C code from K. -- [json](json.md): JSON datatype and parsers/unparsers for JSON strings. -- [rat](rat.md): Rational number representation. -- [substitution](substitution.md): Hooked implementation of capture-aware +- [prelude](builtin/prelude.md): Automatically included into every K definition. +- [ffi](builtin/ffi.md): FFI interface for calling out to native C code from K. +- [json](builtin/json.md): JSON datatype and parsers/unparsers for JSON strings. +- [rat](builtin/rat.md): Rational number representation. +- [substitution](builtin/substitution.md): Hooked implementation of capture-aware sustitution for K definitions. - [unification](https://github.com/runtimeverification/k/blob/master/k-distribution/include/kframework/builtin/unification.k): Hooked implementation of unification exposed directly to K definitions. diff --git a/web/toc.md b/web/toc.md index 64f77e088d3..2c458b00ac4 100644 --- a/web/toc.md +++ b/web/toc.md @@ -62,7 +62,7 @@ output: - [K User Manual](/docs/user_manual.md) - [K Cheat Sheet](/docs/cheat_sheet.md) - [K Tool Reference](/docs/ktools.md) -- [K Builtins](/k-distribution/include/kframework/builtin/README.md) +- [K Builtins](/k-distribution/include/kframework/README.md) - [domains](/k-distribution/include/kframework/builtin/domains.md) - [kast](/k-distribution/include/kframework/builtin/kast.md) - [prelude](/k-distribution/include/kframework/builtin/prelude.md)