openmediavault/openmediavault-docs

correct "mkconf" references in OMV 5.x docs

mi-hol opened this issue · 9 comments

votdev commented

Could you please go a little bit more into detail what needs to be done? I do not have the time to read through a complete forum post to get the information and finally guess what is meant. All necessary information should be mentioned here, that should avoid misunderstandings if i don't have to read what is meant between the lines.

mi-hol commented

text was just a reminder to myself to avoid forgetting but forgot to assign it to myself :)

open actions:

  • verify ryecoaaron's and gderf's statements in the specifically referenced post are correct

omv-mkconf is only relevant for pre-5.x versions of OMV.
All the mkconf scripts have been removed from my OMV 5

  • if confirmed, remove mkconf from docs and repository (as title states)
mi-hol commented

openmediavault/deb/openmediavault/debian/changelog
includes the statement:
"openmediavault (5.0-1) unstable; urgency=low

  • The omv-salt CLI command superseds omv-mkconf."

but below listed official plugins still use it for "Action to be done depending on the previous version."

  • deb/openmediavault-shairport/debian/openmediavault-shairport.postinst
  • deb/openmediavault-usbbackup/debian/openmediavault-usbbackup.postinst
  • deb/openmediavault-nut/debian/openmediavault-nut.postinst
mi-hol commented

@votdev would it make sense to remove omv-mkconf from the 3 plugins listed above?

ryecoaaron commented

@mi-hol You really need to look at the code and listen to people who know.

It doesn't matter if it is in the code because the omv-mkconf binary does not exist in 5.x. Look in this directory - https://github.com/openmediavault/openmediavault/tree/5.x/deb/openmediavault/usr/sbin

It doesn't matter if it is in the postinst script because it is only called in legacy. In the shairport plugin, it would only be called if the version was less than 2.4. In the usbbackup plugin, only if less than 4.0.7. In the nut plugin, only if less than 3.0.2. If Volker chooses to leave that code in there (knowing it would never be called) for historical reasons, that is his right.

mi-hol commented

@ryecoaaron I am listening, that's the reason I tried to verify the statements made.
If they are confirm a cleanup of docs is required.
Obviously I'm still learning and your reply adds another (previously unknown) piece of the puzzle

ryecoaaron commented

Volker shouldn't have to "verify" everything. I think I should classify as an expert and not need every statement I make verified. That is a waste of Volker's time.

mi-hol commented

@votdev your commit 92eade8 removed some references to obsolete mkconf utility but 4 references are still found.

Its not clear to me how I could correct them. Could you please step in?
To see them https://openmediavault.readthedocs.io/en/5.x/search.html?q=mkconf&check_keywords=yes&area=default

mi-hol commented

Volker shouldn't have to "verify" everything. I think I should classify as an expert and not need every statement I make verified. That is a waste of Volker's time.

I'm not a native speaker, hence "verify" may be the wrong word.
The goal is to make the documentation consistent and correct.
You are always welcome to make a contribution to documentation based on your knowledge.