From owner-freebsd-git@freebsd.org Thu Jun 25 17:21:47 2020 Return-Path: Delivered-To: freebsd-git@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id AF3F435FE67 for ; Thu, 25 Jun 2020 17:21:47 +0000 (UTC) (envelope-from arichardson.kde@gmail.com) Received: from mail-ed1-f68.google.com (mail-ed1-f68.google.com [209.85.208.68]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "smtp.gmail.com", Issuer "GTS CA 1O1" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 49t6JC2p4pz4LrH; Thu, 25 Jun 2020 17:21:47 +0000 (UTC) (envelope-from arichardson.kde@gmail.com) Received: by mail-ed1-f68.google.com with SMTP id m21so4802247eds.13; Thu, 25 Jun 2020 10:21:47 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=McczE3CLUBoZcxlcfDbj66RpDWBwSVuQN0NToUengv4=; b=P7k4ygReh8YZnHuqv9w3nec+j4s5SHYJGBIbWdeuLG9bGEQebi1THR0JU7AtO7YaDQ W0VkLgmJaFZEPZu0EphkrUPs6cOo+Me36brs2NIpXl6no7LTgOIqmEr2URJ2g1CHfnu4 FwPyvLEQ3fWtVST/kziov2QDCc+sEsSNdREjplofhHh5bm7oHjaJT/lhjMmqJc0CXgiF E+BvzGQFxMccwCJeBRslQEdqFfM/isf91hmu9ZDg5MP0EckKXGRAYH+UtmKzhmGn3lRZ +3o0ACm02EMBd/6XDe/fxEjytbWz5Aiz50eiGu76t544habgWMohmI3T/Oy8vFwCz29t T0nA== X-Gm-Message-State: AOAM5300eQdwND9iLA082BZoLvJq/lgEO0xQ9mIoxwUkHpKhGecVafbB 8vwMVk+/de56UuGrY6Y4Iy4KolqAyhQ= X-Google-Smtp-Source: ABdhPJzbuyCiplFiWqqpUKfmeDwAXP6/WYSNf33ZV+4SDbj1x2MuYlXKkAOySKhe7NEyGzn6vjKXTA== X-Received: by 2002:aa7:da89:: with SMTP id q9mr14870959eds.273.1593105705773; Thu, 25 Jun 2020 10:21:45 -0700 (PDT) Received: from mail-wm1-f45.google.com (mail-wm1-f45.google.com. [209.85.128.45]) by smtp.gmail.com with ESMTPSA id u60sm11115259edc.59.2020.06.25.10.21.45 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 25 Jun 2020 10:21:45 -0700 (PDT) Received: by mail-wm1-f45.google.com with SMTP id 17so6774233wmo.1; Thu, 25 Jun 2020 10:21:45 -0700 (PDT) X-Received: by 2002:a1c:2044:: with SMTP id g65mr4992687wmg.16.1593105704723; Thu, 25 Jun 2020 10:21:44 -0700 (PDT) MIME-Version: 1.0 References: <20200625165547.GA75705@spindle.one-eyed-alien.net> In-Reply-To: <20200625165547.GA75705@spindle.one-eyed-alien.net> From: Alexander Richardson Date: Thu, 25 Jun 2020 18:21:32 +0100 X-Gmail-Original-Message-ID: Message-ID: Subject: Re: svn primer translation to git To: Brooks Davis Cc: Ed Maste , freebsd-git@freebsd.org Content-Type: text/plain; charset="UTF-8" X-Rspamd-Queue-Id: 49t6JC2p4pz4LrH X-Spamd-Bar: ---- Authentication-Results: mx1.freebsd.org; none X-Spamd-Result: default: False [-4.00 / 15.00]; ASN(0.00)[asn:15169, ipnet:209.85.128.0/17, country:US]; TAGGED_FROM(0.00)[]; REPLY(-4.00)[] X-BeenThere: freebsd-git@freebsd.org X-Mailman-Version: 2.1.33 Precedence: list List-Id: Discussion of git use in the FreeBSD project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 25 Jun 2020 17:21:47 -0000 On Thu, 25 Jun 2020 at 17:55, Brooks Davis wrote: > > On Wed, Jun 24, 2020 at 12:34:33PM -0400, Ed Maste wrote: > > We currently have a FreeBSD Subversion primer in the committer's guide: > > https://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/subversion-primer.html > > > > I've started a translation of this into a Git primer, at: > > https://hackmd.io/ML5TSl8mQ5-27B5eqDf7YA?view > > > > I'm particularly interested in feedback on how much git background / > > theory of operation we want to include here (vs referring to external > > documentation). > > One result of this being a translation of the SVN guide is that it's not > IMO GIT-centric enough. It suggests a number of things that are in > fact excellent foot cannons (git commit -a being the most egregious). > I'd like our document to recommend practices that make it relatively > easy to double and triple check commits. E.g. for direct commit I > generally follow a process of staging with `git add -p` + `git add` for > new files followed by `git status` and/or `git diff --staged`, and then > `git commit`. > > Obviously people will have varying workflows, but for people with little > git experience, let's try to prime them with good ones (unlike the > quickstart tutorials that do things like `git commit -a -m "foo"`). I know many people don't like using graphical tools for this, and despite it not being a particularly nice UI, I find `git gui` to work very well for checking that I don't accidentally commit something I didn't mean to commit. It also makes adding individual lines a lot easier than git add -p. Recent versions of CLion also have a reasonably nice UI to avoid that problem. Alex