Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@kvakvs
Copy link
Collaborator

@kvakvs kvakvs commented Sep 15, 2025

The Observed

The build make docs fails if some application was skipped by the configure for whatever reason or by the user's request. In the original bug report the application was odbc.

The Expected

The build doesn't fail even if docs are partially not built for the reason of some app being skipped.

The Solution

Elixir doc script was modified to read the lib/SKIP-APPLICATIONS and then the documentation redirects for those applications would be skipped too. This results in stub markdown file being shown, containing only application name as a title. Additional change to the Help-makefile: adding a line of explanation to the markdown stub files:

MISSING_APP_DISCLAIMER="The documentation for this application was not generated because ..."
screenshot

@kvakvs kvakvs self-assigned this Sep 15, 2025
@kvakvs kvakvs added the team:PS Assigned to OTP team PS label Sep 15, 2025
@kvakvs kvakvs changed the base branch from master to maint September 15, 2025 12:51
@github-actions
Copy link
Contributor

github-actions bot commented Sep 15, 2025

CT Test Results

  1 files   11 suites   3m 0s ⏱️
 95 tests  91 ✅ 4 💤 0 ❌
111 runs  107 ✅ 4 💤 0 ❌

Results for commit fdf4cc3.

♻️ This comment has been updated with latest results.

To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass.

See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally.

Artifacts

// Erlang/OTP Github Action Bot

@kvakvs kvakvs force-pushed the eimytdl/no-build-doc-if-skipped/OTP-19771 branch 2 times, most recently from 9b3ce1e to bdd04de Compare September 15, 2025 12:55
@kvakvs kvakvs requested a review from IngelaAndin September 15, 2025 12:56
@kvakvs kvakvs force-pushed the eimytdl/no-build-doc-if-skipped/OTP-19771 branch from 4927073 to dbf09a4 Compare September 23, 2025 12:23
IngelaAndin
IngelaAndin previously approved these changes Sep 23, 2025
@kvakvs kvakvs force-pushed the eimytdl/no-build-doc-if-skipped/OTP-19771 branch from dbf09a4 to fdf4cc3 Compare September 24, 2025 12:29
@kvakvs kvakvs merged commit d33e1a5 into erlang:maint Sep 24, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team:PS Assigned to OTP team PS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants