From: Felipe Contreras <firstname.lastname@example.org> To: email@example.com Cc: "Junio C Hamano" <firstname.lastname@example.org>, "Jonathan Nieder" <email@example.com>, "Jeff King" <firstname.lastname@example.org>, "Scott Chacon" <email@example.com>, "Paolo Ciarrocchi" <firstname.lastname@example.org>, "Jakub Narębski" <email@example.com>, "Johannes Schindelin" <firstname.lastname@example.org>, "Matthieu Moy" <email@example.com>, "Piotr Krukowiecki" <firstname.lastname@example.org> Subject: [1.8.0] use 'stage' term consistently Date: Sat, 5 May 2012 15:04:25 +0200 [thread overview] Message-ID: <CAMP44s1qqpTxRvjEH32MNqzUeNhgZ1gB+fu=cgvxnSbMB6oBGA@mail.gmail.com> (raw) Proposal: Avoid the terms 'cache' and 'index' in favor of 'stage'. Advantages: The term 'stage' is more intuitive for newcomers which are more familiar with English than with git, and it seems to be a straightforward mental notion for people from different mother tongues. It is so intuitive that it is used already in a lot online documentation, and the people that do teach git professionally use this term. Risks: People might be accustomed to the current options, and might take some time to get used to the new term. Scripts might be relying on the current options. There's also the possibility that a lot of people prefer the terms 'cache' and 'index', but from the countless discussions on this subject, that seems to be rather unlikely. Migration plan: Follow a typical obsolete/deprecate process; for a period of time warn that the options are obsolete and shouldn't be used, in case there's a lot of people against this, this period would allow for them to shout; then remove them. Rationale: First of all, this discussion _always_ keeps coming back, so its clear something needs to be done, and in the last big discussion the consensus was that 'stage' was the best option. In summary: cache: a 'cache' is a place for easier access; a squirrel caches nuts so it doesn't have to go looking for them in the future when it might be much more difficult. Git porcelain is not using the staging area for easier future access; it's not a cache. index: an 'index' is a guide of pointers to something else; a book index has a list of entries so the reader can locate information easily without having to go through the whole book. Git porcelain is not using the staging area to find out entries quicker; it's not an index. stage: a 'stage' is a special area designated for convenience in order for some activity to take place; an orator would prepare a stage in order for her speak to be successful, otherwise many people might not be able to hear, or see her. Git porcelain is using the staging area precisly as a special area to be separated from the working directory for convenience. The term 'stage' is a good noun itself, but also 'staging area', it has a good verb; 'to stage', and a nice past-participle; 'staged'. -- Felipe Contreras
next reply other threads:[~2012-05-05 13:04 UTC|newest] Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top 2012-05-05 13:04 Felipe Contreras [this message] 2012-05-05 16:52 ` Philip Oakley 2012-05-05 17:30 ` Felipe Contreras 2012-05-05 19:53 ` Philip Oakley 2012-05-06 9:53 ` Zbigniew Jędrzejewski-Szmek 2012-05-06 10:21 ` Jakub Narebski 2012-05-06 10:39 ` Matthieu Moy 2012-05-06 20:15 ` Felipe Contreras 2012-05-06 21:21 ` Jakub Narebski 2012-05-08 3:51 ` Junio C Hamano 2012-05-06 21:09 ` Felipe Contreras 2012-05-06 10:26 ` Matthieu Moy 2012-05-06 21:16 ` Felipe Contreras 2012-05-06 21:30 ` Ævar Arnfjörð Bjarmason 2012-05-07 17:52 ` Junio C Hamano 2012-05-07 20:05 ` Ævar Arnfjörð Bjarmason 2012-05-08 4:06 ` Junio C Hamano 2012-05-08 8:55 ` Ævar Arnfjörð Bjarmason 2012-05-08 14:53 ` Junio C Hamano 2012-05-09 13:10 ` Felipe Contreras 2012-05-09 17:25 ` Matthieu Moy 2012-05-19 0:50 ` Mark Lodato 2012-05-19 6:00 ` Jonathan Nieder 2012-05-19 6:32 ` Jonathan Nieder 2012-05-20 12:04 ` Felipe Contreras 2012-05-20 18:06 ` Jonathan Nieder 2012-05-19 10:14 ` Philip Oakley 2012-05-20 11:49 ` Felipe Contreras 2012-05-20 17:58 ` Jonathan Nieder 2012-05-20 21:11 ` Junio C Hamano 2012-05-21 1:12 ` Felipe Contreras 2012-05-21 1:32 ` Jonathan Nieder 2012-05-18 20:34 ` Thiago Farina 2012-05-08 14:01 ` Sebastien Douche
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to='CAMP44s1qqpTxRvjEH32MNqzUeNhgZ1gB+fu=cgvxnSbMB6oBGA@mail.gmail.com' \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --subject='Re: [1.8.0] use '\''stage'\'' term consistently' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).