Better file conflict message #766
Merged
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
When parts conflict the message is plain and blunt, we should do some hand holding. LP: #1617390 Signed-off-by: Sergio Schvezov <sergio.schvezov@ubuntu.com>
|
|
||
|
|
||
| class SnapcraftError(Exception): | ||
| """Base class for all storeapi exceptions. |
There was a problem hiding this comment.
Copy and paste typo from storeapi/errors.py?
|
thanks @evandandrea I'll apply some fixes from your comments. Is the messaging ok now or think it still needs improvements? |
|
The messaging is much improved, thank you. |
| '- `snap`\n' | ||
| '- `organize`\n\n' | ||
| 'Learn more about these part keywords by running ' | ||
| '`snapcraft help plugins`' |
There was a problem hiding this comment.
This message is wonderful, but if there are more than a few files in that conflict list I could see it becoming less digestible. A little whitespace might help-- compare this:
Parts 'foo' and 'bar' have the following file paths in common which have different contents:
/home/foo/bar/baz/parts/qux/install/usr/include/my_include1.h
/home/foo/bar/baz/parts/qux/install/usr/include/my_include2.h
/home/foo/bar/baz/parts/qux/install/usr/include/my_include3.h
/home/foo/bar/baz/parts/qux/install/usr/include/my_include4.h
Snapcraft offers some capabilities to solve this the following keywords:
- `filesets`
- `stage`
- `snap`
- `organize`
Learn more about these part keywords by running `snapcraft help plugins`
With this:
Parts 'foo' and 'bar' have the following file paths in common which have different contents:
/home/foo/bar/baz/parts/qux/install/usr/include/my_include1.h
/home/foo/bar/baz/parts/qux/install/usr/include/my_include2.h
/home/foo/bar/baz/parts/qux/install/usr/include/my_include3.h
/home/foo/bar/baz/parts/qux/install/usr/include/my_include4.h
Snapcraft offers some capabilities to solve this the following keywords:
- `filesets`
- `stage`
- `snap`
- `organize`
Learn more about these part keywords by running `snapcraft help plugins`
|
@kyrofa point taken! |
…ns/snapcraft into bugfix/1617390/conflict_message
|
👍 from me! Once the tests pass. |
| 'Learn more about these part keywords by running ' | ||
| '`snapcraft help plugins`' | ||
| ) | ||
| self.assertThat(exception.output, Contains(expected_help)) |
There was a problem hiding this comment.
update the copyright year, please
…ns/snapcraft into bugfix/1617390/conflict_message
kalikiana
pushed a commit
to kalikiana/snapcraft
that referenced
this pull request
Apr 6, 2017
When parts conflict the message is plain and blunt, we should do some hand holding. LP: #1617390 Signed-off-by: Sergio Schvezov <sergio.schvezov@ubuntu.com>
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.
When parts conflict the message is plain and blunt, we
should do some hand holding.
LP: #1617390
Signed-off-by: Sergio Schvezov sergio.schvezov@ubuntu.com