Drop obsolete comment documenting a feature that does not exists #392
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jreidinger
reviewed
Nov 2, 2023
| @@ -89,8 +89,7 @@ def self.attributes | |||
| # @return [String,nil] Default shell | |||
| # | |||
| # @!attribute user_password | |||
| # @return [String,nil] User's password. If set to an exclamation mark ('!'), | |||
| # a random password is generated. See #encrypted. | |||
| # @return [String,nil] User's password. | |||
There was a problem hiding this comment.
yeap, it is not random, but it disables login with password. Quotation from man page for shadow:
If the password field contains some string that is not a valid result of crypt(3), for instance ! or *, the user will not be able to use a unix password to log in (but the
user may log in the system by other means).
Pull Request Test Coverage Report for Build 6712645153
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
While working on bsc#1216518 [*] where the SUSE docs implied the feature described by this comment existed I encountered this comment that confirmed the implication made by the docs. The docs should be hopefully fixed in the future but the existence of this comment is confusing as it implies this (now?) non-existent feature does exist.
[*] Not relevant to the comment itself so I did not mention the bug in the commit.
Solution
Remove the part of the documenting comment that talks about the feature (random number being generated when '!' is used in the AutoYaST profile with the password declared as not encrypted).
Note: I also removed the second sentence referencing to the
encryptedattribute. I did this because that attribute affects how the '!' password is interpreted and the reference was immediately after the removed part (rather than after the description of theuser_passwordattribute) so I assumed the reference existed because of the random password feature. If it should remain, let me know and I will amend the commit.