Skip to content

doc: add ctime_tests usage instructions to README#1803

Closed
8144225309 wants to merge 1 commit intobitcoin-core:masterfrom
8144225309:fix-ctime-usage-message
Closed

doc: add ctime_tests usage instructions to README#1803
8144225309 wants to merge 1 commit intobitcoin-core:masterfrom
8144225309:fix-ctime-usage-message

Conversation

@8144225309
Copy link
Contributor

Motivation

When building with CMake and running ctime_tests, users see a message suggesting libtool, which is Autotools-specific:

Before

$ ./build/bin/ctime_tests
This test can only usefully be run inside valgrind because it was not compiled under msan.
Usage: libtool --mode=execute valgrind ./ctime_tests

This is confusing for CMake users since they don't have libtool. Reported in #1697.

Solution

Following the approach in #1778, replace the build-system-specific command with a pointer to README.md and document both methods there.

After

$ ./build/bin/ctime_tests
This test can only usefully be run inside valgrind because it was not compiled under msan.
See README.md for usage instructions.

The README now includes instructions for both build systems.

Fixes #1697

The usage hint in ctime_tests.c suggests libtool, which only
applies to Autotools builds. Point to README.md instead.

Fixes bitcoin-core#1697
@hebasto
Copy link
Member

hebasto commented Jan 22, 2026

Concept ACK.

@8144225309 8144225309 closed this Jan 22, 2026
@8144225309
Copy link
Contributor Author

do you like this style better or #1804 ??

@real-or-random
Copy link
Contributor

I prefer #1804.

@real-or-random real-or-random added tweak/refactor meta/development processes, conventions, developer documentation, etc. user-documentation user-facing documentation and removed meta/development processes, conventions, developer documentation, etc. labels Jan 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tweak/refactor user-documentation user-facing documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

test: ctime_tests usage always suggests using libtool

3 participants