MariaDB / MariaDB/mariadb-docker
docs inaccuracy for MARIADB_DISABLE_UPGRADE_BACKUP
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 931
- Forks
- 445
- PR merge metrics
- No merged PRs in 30d
Description
MariaDB docs (on Docker Hub here and at mariadb.com here) for MARIADB_DISABLE_UPGRADE_BACKUP are inaccurate (inconsistent with the current code):
Docs:
This backup process can be disabled with by setting MARIADB_DISABLE_UPGRADE_BACKUP to a non-empty value."
(e.g. https://hub.docker.com/_/mariadb)
vs. code:
{
if [ -n "$MARIADB_DISABLE_UPGRADE_BACKUP" ] \
&& [ "$MARIADB_DISABLE_UPGRADE_BACKUP" = 1 ]; then
mysql_note "MariaDB upgrade backup disabled due to \$MARIADB_DISABLE_UPGRADE_BACKUP=1 setting"
return
[ https://github.com/MariaDB/mariadb-docker/blob/master/docker-entrypoint.sh#L369 ]
Note also this issue, which affects multiple places (see list):
= and == are for string comparisons
-eq is for numeric comparisons
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docker-entrypoint.sh around line 369 and compare its MARIADB_DISABLE_UPGRADE_BACKUP condition with the wording on the Docker Hub and MariaDB documentation pages. Update the documentation so it matches the current condition and verify the related shell comparison guidance where applicable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, shell
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100