It's all about the answers!

Ask a question

Bug - "help diff" documentation of lscm utility is incomplete /poor


Qua K (132) | asked Mar 06 '21, 6:37 a.m.

 I lost a lot of time just to figure out  how to get a diff of a changeset  (like in git we have "git show <commit id>") .

"lsc help diff" gives me this:

>lscm help diff 

Help for: lscm diff

Purpose: 
  Compares two states of a file or set of files and displays the differences
  between them.

Comparing files:
When you select a file, the version of the
  file on disk is used as the after state. By default the before state is the
  before state of the most recent change.

Comparing change sets:
When you
  select a change set, by default all changes made in that change-set will be
  displayed.

Comparing workspaces or streams:
When you select a workspace or
  stream, the default before state is the selected workspace's or stream's
  current collaboration.

Comparing snapshots:
When you select a snapshot, the
  default "before" state is the workspace or stream that is associated with the
  snapshot.

Comparing baselines:
When you select a baseline, the default
  "before" state is the previous baseline in the history.

Usage: lscm diff [-r/--repository-uri <arg>] [-u/--username <arg> -P/--password
                 <arg> | -u/--username <arg> --password-file <arg> |
                 --certificate <arg> -P/--password <arg> | --smartCard
                 -u/--username <arg> | --kerberos | --integratedWindows]
                 [-d/--directory <arg>] [-N/--no-local-refresh]
                 [-w/--workspace <arg>] [-c/--component <arg>]
                 [[-x/--xcompare] [-S/--show <arg>] | [-p/--fullpatch]]
                 <after-type> <after-selector> [before-type] [before-selector]
                 [-m/--maximum <arg>] [-f/--file <arg ...>]

  after-type      - Type of the item to use for the after state (file,
                    workspace, stream, baseline, change set, snapshot).
  after-selector  - Selector of the item to use for the after state (path of
                    the the file on disk, name[@repo], alias or UUID[@repo]).
  before-type     - Type of the item to use for the before state (workspace,
                    stream, baseline, change set, snapshot).
  before-selector - Selector of the item to use for the before state
                    (name[@repo], alias or UUID[@repo]).

Options:
  -r, --repository-uri <arg>  - The URI that specifies the location of the
                                repository.
  -u, --username <arg>        - The user name for the repository.
  -P, --password <arg>        - The password for the repository. 
      --password-file <arg>   - File that contains the user's password.
      --certificate <arg>     - The file that contains the user's login
                                certificate.
      --smartCard             - Use the connected smart card for
                                authentication.
      --kerberos              - Authenticate with Windows user credentials
                                using Kerberos/SPNeGO.
      --integratedWindows     - Authenticate with Windows user credentials
                                using Integrated Windows Authentication.
  -d, --directory <arg>       - Specifies the root of the shared file system.
  -N, --no-local-refresh      - Does not scan the file system for new changes.
                                This option overrides the value of the
                                'refresh.local.changes' preference. To see the
                                current value of this preference, run 'lscm
                                get preference refresh.local.changes'.
  -w, --workspace <arg>       - The workspace that contains the change set. To
                                specify the workspace, use its name[@repo],
                                alias, or UUID[@repo].
  -c, --component <arg>       - The component to select when you compare
                                workspaces, streams, snapshots, or baselines.
                                The component is identified by a name, alias,
                                or UUID. This option is required when you
                                specify a baseline by name; otherwise, this
                                option is optional.
  -x, --xcompare              - Opens an external compare tool that is
                                configured in the preferences. This option
                                only applies when the type is file and the
                                tool will only show content differences.
  -S, --show <arg>            - Indicates whether to display the differences in
                                content, properties, or both. Use "c" for
                                content, "p" for properties or "cp" for both.
                                By default, differences in content is shown.
  -p, --fullpatch             - Produces a full Jazz patch.
  -m, --maximum <arg>         - The maximum number of change sets that can be
                                returned. The number must be greater than 0.
                                If you omit this option, 512 is used by
                                default. If you specify "all"/"-" then the
                                entire difference is displayed.
  -f, --file <arg ...>        - Show the differences for a set of files within
                                the specified before or after selector.
                                Specify the alias, UUID or path of the files.

The documentation around "selector"  above is very poor and does not specify the exact values (variants) to be passed.

One answer



permanent link
Geoffrey Clemm (30.0k23035) | answered Mar 06 '21, 12:52 p.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

If you find a bug in the documentation, it is always best to submit it as a defect on jazz.net.   The documentation team is usually very responsive in getting documentation fixes into the next release.   If you have a proposal for what the revised documentation should say, that is even better.

Your answer


Register or to post your answer.