Re: [PATCH v2] Group the default git help message by topic

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Wincent Colaiuta wrote:
El 11/06/2010, a las 18:03, Scott Chacon escribió:

+	puts("The most commonly used git commands are:\n");
+
+	puts("Basic Commands:");
+	print_command("init");
+	print_command("clone");
+	print_command("add");
+	print_command("status");
+	print_command("commit");
+	puts("");
+
+	puts("Branch Commands:");
+	print_command("branch");
+	print_command("checkout");
+	print_command("merge");
+	print_command("tag");
+	puts("");
+
+	puts("History Commands:");
+	print_command("log");
+	print_command("diff");
+	print_command("reset");
+	print_command("show");
+	puts("");
+
+	puts("Remote Commands:");
+	print_command("remote");
+	print_command("fetch");
+	print_command("pull");
+	print_command("push");

Nice. I'm sure the output will be a bit less intimidating, but I am not sure about some of the grouping choices you've made here.

"git checkout" is almost certainly a "Basic" command, even though it's used for creating and switching branches.

"git tag" doesn't really seem to be a "Branch" command, as it's for tagging objects (usually commits), and not branches.

"git reset" is the odd one out in the "History" commands group. The other three commands are about _inspecting_ history, whereas "git reset" is about changing the current HEAD. I actually think "git reset" fits better with the "Branch" commands.

I think I'd be inclined to use more descriptive headings and group the commands like this:

  Basic operation:
    init
    add
    status
    commit
    checkout

  Inspecting repository state and history:
    log
    diff
    show

  Working with branches:
    branch
    merge
    reset

  Interacting with other repositories:
    clone
    fetch
    pull
    push
    remote

...</end of my 2 cents>

Can a command be listed twice? Some of these commands _really_ belong in more than one category.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]