Skip to content
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.

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

Docs for cc_common / create_cc_toolchain_config_info disappeared #18267

Open
jfirebaugh opened this issue Apr 28, 2023 · 6 comments
Open

Docs for cc_common / create_cc_toolchain_config_info disappeared #18267

jfirebaugh opened this issue Apr 28, 2023 · 6 comments
Assignees
Labels
team-Documentation Documentation improvements that cannot be directly linked to other team labels team-Rules-CPP Issues for C++ rules type: documentation (cleanup) untriaged

Comments

@jfirebaugh
Copy link

jfirebaugh commented Apr 28, 2023

Page link:

https://bazel.build/rules/lib/cc_common

Problem description (include actual vs expected text, if applicable):

This link used to work, but now it is a 404.

It's linked from pages like https://bazel.build/docs/cc-toolchain-config-reference ("You can create the CcToolchainConfigInfo by calling cc_common.create_cc_toolchain_config_info()").

As far as I can tell this documentation is no longer available anywhere else on the docs site.

Where do you see this issue? (include link to specific section of the page, if applicable)

No response

Any other information you'd like to share?

No response

@jfirebaugh jfirebaugh added team-Documentation Documentation improvements that cannot be directly linked to other team labels type: documentation (cleanup) untriaged labels Apr 28, 2023
@jfirebaugh
Copy link
Author

Found it here: https://bazel.build/versions/6.0.0/rules/lib/cc_common.

But existing links are still broken.

@sgowroji
Copy link
Member

sgowroji commented May 2, 2023

You can access here create_cc_toolchain_config_info.

@brentleyjones
Copy link
Contributor

brentleyjones commented May 4, 2023

That doc still links to something that 404s. So the doc should minimally be updated. Also, the page you linked to doesn't have the create method?

@Wyverald
Copy link
Member

It seems that this is due to the symbol being renamed to cc_common_internal_do_not_use.

@Wyverald
Copy link
Member

@oquenchil @buildbreaker2021 Is this page https://bazel.build/docs/cc-toolchain-config-reference still relevant? It doesn't seem to be linked from anywhere.

@fmeum
Copy link
Collaborator

fmeum commented Jul 11, 2023

I have #18849 in flight to rename the symbol back.

@iancha1992 iancha1992 added the team-Rules-CPP Issues for C++ rules label Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team-Documentation Documentation improvements that cannot be directly linked to other team labels team-Rules-CPP Issues for C++ rules type: documentation (cleanup) untriaged
Projects
None yet
Development

No branches or pull requests

7 participants