Fossil SCM
Improvements to the help text and code comments for the "describe" command.
Commit
52dd8a91bf2e689010ce8c0bfc2ae0e27d13abea814589d0f82c8d209dc6ad60
Parent
951cf9faf3968df…
1 file changed
+15
-12
+15
-12
| --- src/info.c | ||
| +++ src/info.c | ||
| @@ -3681,27 +3681,27 @@ | ||
| 3681 | 3681 | db_finalize(&q); |
| 3682 | 3682 | } |
| 3683 | 3683 | |
| 3684 | 3684 | #if INTERFACE |
| 3685 | 3685 | /* |
| 3686 | -** Description of a checkin relative to an earlier, tagged checkin. | |
| 3686 | +** Description of a check-in relative to an earlier, tagged check-in. | |
| 3687 | 3687 | */ |
| 3688 | 3688 | typedef struct CommitDescr { |
| 3689 | - char *zRelTagname; /* Tag name on the relative checkin */ | |
| 3689 | + char *zRelTagname; /* Tag name on the relative check-in */ | |
| 3690 | 3690 | int nCommitsSince; /* Number of commits since then */ |
| 3691 | - char *zCommitHash; /* Hash of the described checkin */ | |
| 3691 | + char *zCommitHash; /* Hash of the described check-in */ | |
| 3692 | 3692 | int isDirty; /* Working directory has uncommitted changes */ |
| 3693 | 3693 | } CommitDescr; |
| 3694 | 3694 | #endif |
| 3695 | 3695 | |
| 3696 | 3696 | /* |
| 3697 | -** Describe the checkin given by 'zName', and possibly matching 'matchGlob', | |
| 3698 | -** relative to an earlier, tagged checkin. Use 'descr' for the output. | |
| 3697 | +** Describe the check-in given by 'zName', and possibly matching 'matchGlob', | |
| 3698 | +** relative to an earlier, tagged check-in. Use 'descr' for the output. | |
| 3699 | 3699 | ** |
| 3700 | 3700 | ** Finds the closest ancestor (ignoring merge-ins) that has a non-propagating |
| 3701 | 3701 | ** label tag and the number of steps backwards that we had to search in |
| 3702 | -** order to find that tag. | |
| 3702 | +** order to find that tag. Tags applied to more than one check-in are ignored. | |
| 3703 | 3703 | ** |
| 3704 | 3704 | ** Return values: |
| 3705 | 3705 | ** 0: ok |
| 3706 | 3706 | ** -1: zName does not resolve to a commit |
| 3707 | 3707 | ** -2: zName resolves to more than a commit |
| @@ -3795,20 +3795,23 @@ | ||
| 3795 | 3795 | ** |
| 3796 | 3796 | ** Usage: %fossil describe ?VERSION? ?OPTIONS? |
| 3797 | 3797 | ** |
| 3798 | 3798 | ** Provide a description of the given VERSION by showing a non-propagating |
| 3799 | 3799 | ** tag of the youngest tagged ancestor, followed by the number of commits |
| 3800 | -** since that, and the short hash of VERSION. If VERSION and the found | |
| 3801 | -** ancestor refer to the same commit, the last two components are omitted, | |
| 3802 | -** unless --long is provided. | |
| 3800 | +** since that, and the short hash of VERSION. Only tags applied to a single | |
| 3801 | +** check-in are considered. | |
| 3802 | +** | |
| 3803 | +** If no VERSION is provided, describe the current checked-out version. | |
| 3803 | 3804 | ** |
| 3804 | -** If no VERSION is provided, describe the current checked-out version. When | |
| 3805 | -** no fitting tagged ancestor is found, show only the short hash of VERSION. | |
| 3805 | +** If VERSION and the found ancestor refer to the same commit, the last two | |
| 3806 | +** components are omitted, unless --long is provided. When no fitting tagged | |
| 3807 | +** ancestor is found, show only the short hash of VERSION. | |
| 3806 | 3808 | ** |
| 3807 | 3809 | ** Options: |
| 3808 | 3810 | ** |
| 3809 | -** --digits Display so many hex digits of the hash (default 10) | |
| 3811 | +** --digits Display so many hex digits of the hash | |
| 3812 | +** (default: the larger of 6 and the 'hash-digit' setting) | |
| 3810 | 3813 | ** -d|--dirty Show whether there are changes to be committed |
| 3811 | 3814 | ** --long Always show all three components |
| 3812 | 3815 | ** --match GLOB Consider only non-propagating tags matching GLOB |
| 3813 | 3816 | */ |
| 3814 | 3817 | void describe_cmd(void){ |
| 3815 | 3818 |
| --- src/info.c | |
| +++ src/info.c | |
| @@ -3681,27 +3681,27 @@ | |
| 3681 | db_finalize(&q); |
| 3682 | } |
| 3683 | |
| 3684 | #if INTERFACE |
| 3685 | /* |
| 3686 | ** Description of a checkin relative to an earlier, tagged checkin. |
| 3687 | */ |
| 3688 | typedef struct CommitDescr { |
| 3689 | char *zRelTagname; /* Tag name on the relative checkin */ |
| 3690 | int nCommitsSince; /* Number of commits since then */ |
| 3691 | char *zCommitHash; /* Hash of the described checkin */ |
| 3692 | int isDirty; /* Working directory has uncommitted changes */ |
| 3693 | } CommitDescr; |
| 3694 | #endif |
| 3695 | |
| 3696 | /* |
| 3697 | ** Describe the checkin given by 'zName', and possibly matching 'matchGlob', |
| 3698 | ** relative to an earlier, tagged checkin. Use 'descr' for the output. |
| 3699 | ** |
| 3700 | ** Finds the closest ancestor (ignoring merge-ins) that has a non-propagating |
| 3701 | ** label tag and the number of steps backwards that we had to search in |
| 3702 | ** order to find that tag. |
| 3703 | ** |
| 3704 | ** Return values: |
| 3705 | ** 0: ok |
| 3706 | ** -1: zName does not resolve to a commit |
| 3707 | ** -2: zName resolves to more than a commit |
| @@ -3795,20 +3795,23 @@ | |
| 3795 | ** |
| 3796 | ** Usage: %fossil describe ?VERSION? ?OPTIONS? |
| 3797 | ** |
| 3798 | ** Provide a description of the given VERSION by showing a non-propagating |
| 3799 | ** tag of the youngest tagged ancestor, followed by the number of commits |
| 3800 | ** since that, and the short hash of VERSION. If VERSION and the found |
| 3801 | ** ancestor refer to the same commit, the last two components are omitted, |
| 3802 | ** unless --long is provided. |
| 3803 | ** |
| 3804 | ** If no VERSION is provided, describe the current checked-out version. When |
| 3805 | ** no fitting tagged ancestor is found, show only the short hash of VERSION. |
| 3806 | ** |
| 3807 | ** Options: |
| 3808 | ** |
| 3809 | ** --digits Display so many hex digits of the hash (default 10) |
| 3810 | ** -d|--dirty Show whether there are changes to be committed |
| 3811 | ** --long Always show all three components |
| 3812 | ** --match GLOB Consider only non-propagating tags matching GLOB |
| 3813 | */ |
| 3814 | void describe_cmd(void){ |
| 3815 |
| --- src/info.c | |
| +++ src/info.c | |
| @@ -3681,27 +3681,27 @@ | |
| 3681 | db_finalize(&q); |
| 3682 | } |
| 3683 | |
| 3684 | #if INTERFACE |
| 3685 | /* |
| 3686 | ** Description of a check-in relative to an earlier, tagged check-in. |
| 3687 | */ |
| 3688 | typedef struct CommitDescr { |
| 3689 | char *zRelTagname; /* Tag name on the relative check-in */ |
| 3690 | int nCommitsSince; /* Number of commits since then */ |
| 3691 | char *zCommitHash; /* Hash of the described check-in */ |
| 3692 | int isDirty; /* Working directory has uncommitted changes */ |
| 3693 | } CommitDescr; |
| 3694 | #endif |
| 3695 | |
| 3696 | /* |
| 3697 | ** Describe the check-in given by 'zName', and possibly matching 'matchGlob', |
| 3698 | ** relative to an earlier, tagged check-in. Use 'descr' for the output. |
| 3699 | ** |
| 3700 | ** Finds the closest ancestor (ignoring merge-ins) that has a non-propagating |
| 3701 | ** label tag and the number of steps backwards that we had to search in |
| 3702 | ** order to find that tag. Tags applied to more than one check-in are ignored. |
| 3703 | ** |
| 3704 | ** Return values: |
| 3705 | ** 0: ok |
| 3706 | ** -1: zName does not resolve to a commit |
| 3707 | ** -2: zName resolves to more than a commit |
| @@ -3795,20 +3795,23 @@ | |
| 3795 | ** |
| 3796 | ** Usage: %fossil describe ?VERSION? ?OPTIONS? |
| 3797 | ** |
| 3798 | ** Provide a description of the given VERSION by showing a non-propagating |
| 3799 | ** tag of the youngest tagged ancestor, followed by the number of commits |
| 3800 | ** since that, and the short hash of VERSION. Only tags applied to a single |
| 3801 | ** check-in are considered. |
| 3802 | ** |
| 3803 | ** If no VERSION is provided, describe the current checked-out version. |
| 3804 | ** |
| 3805 | ** If VERSION and the found ancestor refer to the same commit, the last two |
| 3806 | ** components are omitted, unless --long is provided. When no fitting tagged |
| 3807 | ** ancestor is found, show only the short hash of VERSION. |
| 3808 | ** |
| 3809 | ** Options: |
| 3810 | ** |
| 3811 | ** --digits Display so many hex digits of the hash |
| 3812 | ** (default: the larger of 6 and the 'hash-digit' setting) |
| 3813 | ** -d|--dirty Show whether there are changes to be committed |
| 3814 | ** --long Always show all three components |
| 3815 | ** --match GLOB Consider only non-propagating tags matching GLOB |
| 3816 | */ |
| 3817 | void describe_cmd(void){ |
| 3818 |