From 818dee1630b2e976a9f9d8c9c5184dcf98bb9202 Mon Sep 17 00:00:00 2001 From: Larry Gritz Date: Sat, 4 Apr 2026 11:19:14 -0700 Subject: [PATCH] admin: Rename the repo's top level doc/ subdir to docs/ Mostly for conformance with OpenImageIO, since we share so many scripts and management docmentation. But looking across ASWF project, they almost all use "docs/" (OSL and OpenVDB were the only outliers). Signed-off-by: Larry Gritz --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .github/workflows/ci.yml | 4 ++-- CONTRIBUTING.md | 2 +- README.md | 6 +++--- {doc => docs}/README.md | 0 .../app_integration/OptiX-Inlining-Options.md | 0 {doc => docs}/app_integration/README.md | 0 {doc => docs}/build_install/README.md | 2 +- {doc => docs}/build_install/windows/Readme.md | 10 +++++----- {doc => docs}/build_install/windows/build_osl.bat | 0 {doc => docs}/build_install/windows/build_osl.py | 0 .../windows/osl_building_on_windows.jpg | Bin .../build_install/windows/osl_debug_sln.bat | 0 .../build_install/windows/osl_env_vars_setup.bat | 0 .../build_install/windows/osl_release_sln.bat | 0 .../build_install/windows/osltoy_debug_launcher.bat | 0 .../windows/osltoy_release_launcher.bat | 0 {doc => docs}/dev/AI_Policy.md | 0 {doc => docs}/dev/Build_Profiling.md | 0 {doc => docs}/dev/Changes-skeleton-major.md | 0 {doc => docs}/dev/Changes-skeleton-patch.md | 0 {doc => docs}/dev/CodeReview.md | 0 {doc => docs}/dev/RELEASING.md | 4 ++-- {doc => docs}/shader_writing/README.md | 0 {doc => docs}/shader_writing/Shading_in_OSL.odt | Bin {doc => docs}/site/README.md | 0 src/testshade/optixgridrender.cpp | 2 +- 27 files changed, 16 insertions(+), 16 deletions(-) rename {doc => docs}/README.md (100%) rename {doc => docs}/app_integration/OptiX-Inlining-Options.md (100%) rename {doc => docs}/app_integration/README.md (100%) rename {doc => docs}/build_install/README.md (75%) rename {doc => docs}/build_install/windows/Readme.md (96%) rename {doc => docs}/build_install/windows/build_osl.bat (100%) rename {doc => docs}/build_install/windows/build_osl.py (100%) rename {doc => docs}/build_install/windows/osl_building_on_windows.jpg (100%) rename {doc => docs}/build_install/windows/osl_debug_sln.bat (100%) rename {doc => docs}/build_install/windows/osl_env_vars_setup.bat (100%) rename {doc => docs}/build_install/windows/osl_release_sln.bat (100%) rename {doc => docs}/build_install/windows/osltoy_debug_launcher.bat (100%) rename {doc => docs}/build_install/windows/osltoy_release_launcher.bat (100%) rename {doc => docs}/dev/AI_Policy.md (100%) rename {doc => docs}/dev/Build_Profiling.md (100%) rename {doc => docs}/dev/Changes-skeleton-major.md (100%) rename {doc => docs}/dev/Changes-skeleton-patch.md (100%) rename {doc => docs}/dev/CodeReview.md (100%) rename {doc => docs}/dev/RELEASING.md (99%) rename {doc => docs}/shader_writing/README.md (100%) rename {doc => docs}/shader_writing/Shading_in_OSL.odt (100%) rename {doc => docs}/site/README.md (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9d9825b79d..a9899236ca 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -30,7 +30,7 @@ instructions! - [ ] **I have read the guidelines** on [contributions](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage/blob/main/CONTRIBUTING.md) and [code review procedures](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage/blob/main/docs/dev/CodeReview.md). -- [ ] **I have read the [Policy on AI Coding Assistants](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage/blob/main/doc/dev/AI_Policy.md)** +- [ ] **I have read the [Policy on AI Coding Assistants](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage/blob/main/docs/dev/AI_Policy.md)** and if I used AI coding assistants, I have an `Assisted-by: TOOL / MODEL` line in the pull request description above. - [ ] **I have updated the documentation** if my PR adds features or changes diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3cee601622..28691bc926 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,14 +18,14 @@ on: - '!**/analysis.yml' - '!**/docs.yml' - '!**.properties' - - '!doc/**' + - '!docs/**' pull_request: paths: - '**' - '!**.md' - '!**.rst' - '!**.tex' - - '!doc/**' + - '!docs/**' schedule: # Full nightly build, for the main project repo (not for forks) - cron: "0 6 * * *" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1bd07d36e6..ea11ed537b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -271,7 +271,7 @@ first try is not accepted. It happens to all of us. 8. After approval, one of the senior developers (with commit approval to the official main repository) will merge your fixes into the main branch. -Please see the [Code Review](doc/dev/CodeReview.md) document for more +Please see the [Code Review](docs/dev/CodeReview.md) document for more explanaton of the code review process. diff --git a/README.md b/README.md index 69ff495c60..d863725c08 100644 --- a/README.md +++ b/README.md @@ -527,13 +527,13 @@ mechanism. * [CONTRIBUTING](CONTRIBUTING.md) has detailed instructions about the development process. -* [AI Policy](doc/dev/AI_Policy.md) decribes our policies on AI coding +* [AI Policy](docs/dev/AI_Policy.md) decribes our policies on AI coding assistance tools. -* [RELEASING](doc/dev/RELEASING.md) explains our policies and procedures for +* [RELEASING](docs/dev/RELEASING.md) explains our policies and procedures for making releases. We have a major, possibly-compatibility-breaking, release annually in September/October, and minor bug fix and safe feature addition release at the beginning of every month. -* Other developer documentation is in the [doc/dev](doc/dev) directory. +* Other developer documentation is in the [docs/dev](docs/dev) directory. * You may also have luck learning a bit about the organization and architecture of the project by reading the [DeepWiki Analysis of OpenShadingLanguage](https://deepwiki.com/AcademySoftwareFoundation/OpenShadingLanguage). diff --git a/doc/README.md b/docs/README.md similarity index 100% rename from doc/README.md rename to docs/README.md diff --git a/doc/app_integration/OptiX-Inlining-Options.md b/docs/app_integration/OptiX-Inlining-Options.md similarity index 100% rename from doc/app_integration/OptiX-Inlining-Options.md rename to docs/app_integration/OptiX-Inlining-Options.md diff --git a/doc/app_integration/README.md b/docs/app_integration/README.md similarity index 100% rename from doc/app_integration/README.md rename to docs/app_integration/README.md diff --git a/doc/build_install/README.md b/docs/build_install/README.md similarity index 75% rename from doc/build_install/README.md rename to docs/build_install/README.md index cad4a3e7f5..fff5e4be1e 100644 --- a/doc/build_install/README.md +++ b/docs/build_install/README.md @@ -16,6 +16,6 @@ Method #1: https://github.com/debaetsd/OSL_build Method #2: -Go through `doc/build_install/windows/Readme.md` and using batch files to install OSL cleanly! +Go through `docs/build_install/windows/Readme.md` and using batch files to install OSL cleanly! ## macOS diff --git a/doc/build_install/windows/Readme.md b/docs/build_install/windows/Readme.md similarity index 96% rename from doc/build_install/windows/Readme.md rename to docs/build_install/windows/Readme.md index 4213aea9f1..26e67771e4 100644 --- a/doc/build_install/windows/Readme.md +++ b/docs/build_install/windows/Readme.md @@ -104,7 +104,7 @@ so I studied its python build script and found we can use same logic for install It still needs some other works to make it complete for all dependencies (optional). We will keep Pixar name on it as inspiration code (or we can keep their copyright) -You can Run the installer from: `yourpath/OpenShadingLanguage/doc/build_install/windows/build_osl.bat` +You can Run the installer from: `yourpath/OpenShadingLanguage/docs/build_install/windows/build_osl.bat` --- @@ -144,11 +144,11 @@ For running batch scripts without any problem I recommend to create some base en | -Open `doc/build_install/windows/osl_env_vars_setup.bat` in your editor and edit paths' values based on your installation folders. +Open `docs/build_install/windows/osl_env_vars_setup.bat` in your editor and edit paths' values based on your installation folders. ### **2.3 Set Flags based on your needs** -The main build launcher is here `doc/build_install/windows/build_osl.bat` +The main build launcher is here `docs/build_install/windows/build_osl.bat` For now we can not assign pre-installed llvm so we have to build all together at once and put all of them in one directory. @@ -196,7 +196,7 @@ Based on Environment Variables you set in previous sections you can just call th **My Method:** - Open Powershell -- Go to: yourPath/OpenShadingLanguage/doc/build_install/windows +- Go to: yourPath/OpenShadingLanguage/docs/build_install/windows - Run build_osl.bat release ### **3.1 Running the code based on your config** @@ -295,7 +295,7 @@ That's it TIP: this process is getting better, I will update the document soon **Conclusion:** -For easy installation you just need to setup your Environment Variables in `yourPath/OpenShadingLanguage/doc/build_install/windows/osl_env_vars_setup.bat` based on your paths +For easy installation you just need to setup your Environment Variables in `yourPath/OpenShadingLanguage/docs/build_install/windows/osl_env_vars_setup.bat` based on your paths It is a custom setup, for example all dependencies are built before osl, because I had lots of issues on using external installation (like llvm) and I tried this method on llvm 7, 8 and 9, all with error, so my current build setup is on llvm 11 and C++14, it can be changed in code. (I am trying to make it easy to use for changing configs with arguments) diff --git a/doc/build_install/windows/build_osl.bat b/docs/build_install/windows/build_osl.bat similarity index 100% rename from doc/build_install/windows/build_osl.bat rename to docs/build_install/windows/build_osl.bat diff --git a/doc/build_install/windows/build_osl.py b/docs/build_install/windows/build_osl.py similarity index 100% rename from doc/build_install/windows/build_osl.py rename to docs/build_install/windows/build_osl.py diff --git a/doc/build_install/windows/osl_building_on_windows.jpg b/docs/build_install/windows/osl_building_on_windows.jpg similarity index 100% rename from doc/build_install/windows/osl_building_on_windows.jpg rename to docs/build_install/windows/osl_building_on_windows.jpg diff --git a/doc/build_install/windows/osl_debug_sln.bat b/docs/build_install/windows/osl_debug_sln.bat similarity index 100% rename from doc/build_install/windows/osl_debug_sln.bat rename to docs/build_install/windows/osl_debug_sln.bat diff --git a/doc/build_install/windows/osl_env_vars_setup.bat b/docs/build_install/windows/osl_env_vars_setup.bat similarity index 100% rename from doc/build_install/windows/osl_env_vars_setup.bat rename to docs/build_install/windows/osl_env_vars_setup.bat diff --git a/doc/build_install/windows/osl_release_sln.bat b/docs/build_install/windows/osl_release_sln.bat similarity index 100% rename from doc/build_install/windows/osl_release_sln.bat rename to docs/build_install/windows/osl_release_sln.bat diff --git a/doc/build_install/windows/osltoy_debug_launcher.bat b/docs/build_install/windows/osltoy_debug_launcher.bat similarity index 100% rename from doc/build_install/windows/osltoy_debug_launcher.bat rename to docs/build_install/windows/osltoy_debug_launcher.bat diff --git a/doc/build_install/windows/osltoy_release_launcher.bat b/docs/build_install/windows/osltoy_release_launcher.bat similarity index 100% rename from doc/build_install/windows/osltoy_release_launcher.bat rename to docs/build_install/windows/osltoy_release_launcher.bat diff --git a/doc/dev/AI_Policy.md b/docs/dev/AI_Policy.md similarity index 100% rename from doc/dev/AI_Policy.md rename to docs/dev/AI_Policy.md diff --git a/doc/dev/Build_Profiling.md b/docs/dev/Build_Profiling.md similarity index 100% rename from doc/dev/Build_Profiling.md rename to docs/dev/Build_Profiling.md diff --git a/doc/dev/Changes-skeleton-major.md b/docs/dev/Changes-skeleton-major.md similarity index 100% rename from doc/dev/Changes-skeleton-major.md rename to docs/dev/Changes-skeleton-major.md diff --git a/doc/dev/Changes-skeleton-patch.md b/docs/dev/Changes-skeleton-patch.md similarity index 100% rename from doc/dev/Changes-skeleton-patch.md rename to docs/dev/Changes-skeleton-patch.md diff --git a/doc/dev/CodeReview.md b/docs/dev/CodeReview.md similarity index 100% rename from doc/dev/CodeReview.md rename to docs/dev/CodeReview.md diff --git a/doc/dev/RELEASING.md b/docs/dev/RELEASING.md similarity index 99% rename from doc/dev/RELEASING.md rename to docs/dev/RELEASING.md index 36b55f23bf..a6e6c35bc1 100644 --- a/doc/dev/RELEASING.md +++ b/docs/dev/RELEASING.md @@ -392,7 +392,7 @@ use commit hashes to denote the range of changes you want to document. We have found that the git-cliff output is most of what we need for the patch releases, and can be copied into the CHANGES.md file with only some minor editing needed. The template for the patch release notes can be found in -[Changes-skeleton-patch.md](doc/dev/Changes-skeleton-patch.md). +[Changes-skeleton-patch.md](docs/dev/Changes-skeleton-patch.md). * Get rid of the headings that git-cliff generates. We don't use the headings for the patch releases. @@ -422,7 +422,7 @@ for a prose-based description of important changes that "tell the story" of the year's work and will be thoroughly understood by our stakeholders who need to understand what has changed. -* Copy all the headings from [Changes-skeleton-major.md](doc/dev/Changes-skeleton-major.md) +* Copy all the headings from [Changes-skeleton-major.md](docs/dev/Changes-skeleton-major.md) or the previous year's release notes to get the skeleton of the major and minor headers that you fit everything into. Note that it mostly corresponds to sections of the git-cliff output, but with a more carefully constructed diff --git a/doc/shader_writing/README.md b/docs/shader_writing/README.md similarity index 100% rename from doc/shader_writing/README.md rename to docs/shader_writing/README.md diff --git a/doc/shader_writing/Shading_in_OSL.odt b/docs/shader_writing/Shading_in_OSL.odt similarity index 100% rename from doc/shader_writing/Shading_in_OSL.odt rename to docs/shader_writing/Shading_in_OSL.odt diff --git a/doc/site/README.md b/docs/site/README.md similarity index 100% rename from doc/site/README.md rename to docs/site/README.md diff --git a/src/testshade/optixgridrender.cpp b/src/testshade/optixgridrender.cpp index 86a80cbe05..db40e481f2 100644 --- a/src/testshade/optixgridrender.cpp +++ b/src/testshade/optixgridrender.cpp @@ -1171,7 +1171,7 @@ OptixGridRenderer::register_inline_functions() // ShadingSystem attributes enable some degree of fine tuning. This // mechanism has been added to offer a finer degree of control // - // Please refer to doc/app_integration/OptiX-Inlining-Options.md for more + // Please refer to docs/app_integration/OptiX-Inlining-Options.md for more // details about the inlining options. // These functions are all 5 instructions or less in the PTX, with most of