Skip to content

[NFC][analyzer][docs] Remove some orphaned images #122249

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

Closed
wants to merge 1 commit into from

Conversation

NagyDonat
Copy link
Contributor

Remove some images that were previously used on the old homepage of Clang static analyzer (clang-analyzer.llvm.org) but became unused since then.

Among the four removed images, scan_build_cmd.png was copied to a different location within the repository (and the RST-based docs use it from that location); while the other three are not referenced at all (git grep produces no results).

Remove some images that were previously used on the old homepage of
Clang static analyzer (`clang-analyzer.llvm.org`) but became unused
since then.

Among the four removed images, `scan_build_cmd.png` was copied to a
different location within the repository (and the RST-based docs use it
from that location); while the other three are not referenced at all
(`git grep` produces no results).
@llvmbot llvmbot added the clang Clang issues not falling into any other category label Jan 9, 2025
@llvmbot
Copy link
Member

llvmbot commented Jan 9, 2025

@llvm/pr-subscribers-clang

Author: Donát Nagy (NagyDonat)

Changes

Remove some images that were previously used on the old homepage of Clang static analyzer (clang-analyzer.llvm.org) but became unused since then.

Among the four removed images, scan_build_cmd.png was copied to a different location within the repository (and the RST-based docs use it from that location); while the other three are not referenced at all (git grep produces no results).


Full diff: https://github.com/llvm/llvm-project/pull/122249.diff

4 Files Affected:

  • (removed) clang/www/analyzer/images/example_custom_assert.png ()
  • (removed) clang/www/analyzer/images/example_null_pointer.png ()
  • (removed) clang/www/analyzer/images/example_use_assert.png ()
  • (removed) clang/www/analyzer/images/scan_build_cmd.png ()
diff --git a/clang/www/analyzer/images/example_custom_assert.png b/clang/www/analyzer/images/example_custom_assert.png
deleted file mode 100644
index a56bb8962453fe..00000000000000
Binary files a/clang/www/analyzer/images/example_custom_assert.png and /dev/null differ
diff --git a/clang/www/analyzer/images/example_null_pointer.png b/clang/www/analyzer/images/example_null_pointer.png
deleted file mode 100644
index defc3948e9c700..00000000000000
Binary files a/clang/www/analyzer/images/example_null_pointer.png and /dev/null differ
diff --git a/clang/www/analyzer/images/example_use_assert.png b/clang/www/analyzer/images/example_use_assert.png
deleted file mode 100644
index 9e46d7614d625c..00000000000000
Binary files a/clang/www/analyzer/images/example_use_assert.png and /dev/null differ
diff --git a/clang/www/analyzer/images/scan_build_cmd.png b/clang/www/analyzer/images/scan_build_cmd.png
deleted file mode 100644
index 464fd4e129a208..00000000000000
Binary files a/clang/www/analyzer/images/scan_build_cmd.png and /dev/null differ

@steakhal
Copy link
Contributor

steakhal commented Jan 9, 2025

Its usually good practice to refer to the last commit where the dead resources become dead.
You can use the git log -S to find out about the commits the thing is mentioned.

Example: git log -Sexample_custom_assert -- clang/www/analyzer/, will mention:

61a76f58ebf161c739fb196d56c1899735c7cea8 [clang][analyzer][doc] Migrate ClangSA www FAQ section (#112831)

You can get a better understanding if the drop was intentional or accidental.

@NagyDonat
Copy link
Contributor Author

I assumed the correctness of the old commits, but now that I looked into it, it seems that the three example_*.png images were orphaned by PR #112831 which converted the FAQ from HTML to RST. @gamesh411 Why didn't you add these images in the RST version of the FAQ? (I know that they are old and ugly, but it seems that they have provided some additional information/context which is now missing from the FAQ.)

@steakhal
Copy link
Contributor

steakhal commented Jan 9, 2025

Now that I looked at that PR, it was merged without approval, while having open comments.

@NagyDonat
Copy link
Contributor Author

I'll create a commit which restores those three images to the RST FAQ. After that, either I or @gamesh411 can create a follow-up commit that addresses any question in the old review that were forgotten.

@NagyDonat
Copy link
Contributor Author

I created PR #122481 which properly handles these images.

@NagyDonat NagyDonat closed this Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants