diff mbox

dim: Update docs for update-branches

Message ID 20161208174955.10542-1-daniel.vetter@ffwll.ch (mailing list archive)
State New, archived
Headers show

Commit Message

Daniel Vetter Dec. 8, 2016, 5:49 p.m. UTC
It's been years since drm-intel had only one maintainer, and the
primary use-case for dim ub was only to sync between machines. Update
the docs to reflect this, to avoid misleading committers. Also update
the maintainer-tools branch, which is something Paulo's script also
does.

Motivated because Paulo typed an actualize.sh script which does
exactly what dim ub is meant to do.

v2: Also update quickstart guide.

v3: And spelling fixes.

Acked-by: Paulo Zanoni <paulo.r.zanoni@intel.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 dim     |  3 +++
 dim.rst | 11 ++++++-----
 2 files changed, 9 insertions(+), 5 deletions(-)

Comments

Jani Nikula Dec. 8, 2016, 9:53 p.m. UTC | #1
On Thu, 08 Dec 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> It's been years since drm-intel had only one maintainer, and the
> primary use-case for dim ub was only to sync between machines. Update
> the docs to reflect this, to avoid misleading committers. Also update
> the maintainer-tools branch, which is something Paulo's script also
> does.
>
> Motivated because Paulo typed an actualize.sh script which does
> exactly what dim ub is meant to do.
>
> v2: Also update quickstart guide.
>
> v3: And spelling fixes.
>
> Acked-by: Paulo Zanoni <paulo.r.zanoni@intel.com>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
>  dim     |  3 +++
>  dim.rst | 11 ++++++-----
>  2 files changed, 9 insertions(+), 5 deletions(-)
>
> diff --git a/dim b/dim
> index e0551ace54e4..3e82de96b4ab 100755
> --- a/dim
> +++ b/dim
> @@ -1293,6 +1293,9 @@ function dim_update_branches
>  	dim_checkout drm-intel-next
>  	$DRY git reset --hard $DIM_DRM_INTEL_REMOTE/drm-intel-next
>  
> +	cd $DIM_PREFIX/maintainer-tools
> +	git pull --rebase
> +

Ooops?


>  	update_rerere_cache
>  }
>  
> diff --git a/dim.rst b/dim.rst
> index 0c52ab43e400..b9cb41a2ba5b 100644
> --- a/dim.rst
> +++ b/dim.rst
> @@ -74,11 +74,8 @@ Setup git maintainer branches in the given prefix.
>  
>  update-branches
>  ---------------
> -Updates all maintainer branches. Only needs to be run to synchronize branches
> -between different machines (or maintainers fwiw). As long a given branch is
> -always maintained from the same machine, even if different branches are
> -maintained on different machines (by different maintainers), there's no need to
> -run this command.
> +Updates all maintainer branches. Useful to synchronize all branches when other
> +maintainers and committers pushed patches meanwhile.
>  
>  status
>  ------
> @@ -408,6 +405,10 @@ corresponding to this repository is defined by DIM_DRM_INTEL in your .dimrc.
>  You should also have directories called maintainer-tools, drm-tip (for
>  rebuilding the tree), and drm-intel-rerere for some dim-internal book-keeping.
>  
> +If someone else has pushed patches first resync using::
> +
> +   $ dim update-branches
> +
>  Applying patches to dinq is done in the main repository with::
>  
>      $ cat patch.mbox | dim apply-queued
Daniel Vetter Dec. 9, 2016, 9:52 p.m. UTC | #2
On Thu, Dec 08, 2016 at 11:53:07PM +0200, Jani Nikula wrote:
> On Thu, 08 Dec 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> > It's been years since drm-intel had only one maintainer, and the
> > primary use-case for dim ub was only to sync between machines. Update
> > the docs to reflect this, to avoid misleading committers. Also update
> > the maintainer-tools branch, which is something Paulo's script also
> > does.
> >
> > Motivated because Paulo typed an actualize.sh script which does
> > exactly what dim ub is meant to do.
> >
> > v2: Also update quickstart guide.
> >
> > v3: And spelling fixes.
> >
> > Acked-by: Paulo Zanoni <paulo.r.zanoni@intel.com>
> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> > ---
> >  dim     |  3 +++
> >  dim.rst | 11 ++++++-----
> >  2 files changed, 9 insertions(+), 5 deletions(-)
> >
> > diff --git a/dim b/dim
> > index e0551ace54e4..3e82de96b4ab 100755
> > --- a/dim
> > +++ b/dim
> > @@ -1293,6 +1293,9 @@ function dim_update_branches
> >  	dim_checkout drm-intel-next
> >  	$DRY git reset --hard $DIM_DRM_INTEL_REMOTE/drm-intel-next
> >  
> > +	cd $DIM_PREFIX/maintainer-tools
> > +	git pull --rebase
> > +
> 
> Ooops?

From the commit message: "Also update the maintainer-tools branch, which
is something Paulo's script also does." This way dim update-branches
updates everything, and I think that's good, I liked that idea from
Paulo's script a lot.
-Daniel

> 
> 
> >  	update_rerere_cache
> >  }
> >  
> > diff --git a/dim.rst b/dim.rst
> > index 0c52ab43e400..b9cb41a2ba5b 100644
> > --- a/dim.rst
> > +++ b/dim.rst
> > @@ -74,11 +74,8 @@ Setup git maintainer branches in the given prefix.
> >  
> >  update-branches
> >  ---------------
> > -Updates all maintainer branches. Only needs to be run to synchronize branches
> > -between different machines (or maintainers fwiw). As long a given branch is
> > -always maintained from the same machine, even if different branches are
> > -maintained on different machines (by different maintainers), there's no need to
> > -run this command.
> > +Updates all maintainer branches. Useful to synchronize all branches when other
> > +maintainers and committers pushed patches meanwhile.
> >  
> >  status
> >  ------
> > @@ -408,6 +405,10 @@ corresponding to this repository is defined by DIM_DRM_INTEL in your .dimrc.
> >  You should also have directories called maintainer-tools, drm-tip (for
> >  rebuilding the tree), and drm-intel-rerere for some dim-internal book-keeping.
> >  
> > +If someone else has pushed patches first resync using::
> > +
> > +   $ dim update-branches
> > +
> >  Applying patches to dinq is done in the main repository with::
> >  
> >      $ cat patch.mbox | dim apply-queued
> 
> -- 
> Jani Nikula, Intel Open Source Technology Center
Jani Nikula Dec. 12, 2016, 8:14 a.m. UTC | #3
On Fri, 09 Dec 2016, Daniel Vetter <daniel@ffwll.ch> wrote:
> On Thu, Dec 08, 2016 at 11:53:07PM +0200, Jani Nikula wrote:
>> On Thu, 08 Dec 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>> > It's been years since drm-intel had only one maintainer, and the
>> > primary use-case for dim ub was only to sync between machines. Update
>> > the docs to reflect this, to avoid misleading committers. Also update
>> > the maintainer-tools branch, which is something Paulo's script also
>> > does.
>> >
>> > Motivated because Paulo typed an actualize.sh script which does
>> > exactly what dim ub is meant to do.
>> >
>> > v2: Also update quickstart guide.
>> >
>> > v3: And spelling fixes.
>> >
>> > Acked-by: Paulo Zanoni <paulo.r.zanoni@intel.com>
>> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
>> > ---
>> >  dim     |  3 +++
>> >  dim.rst | 11 ++++++-----
>> >  2 files changed, 9 insertions(+), 5 deletions(-)
>> >
>> > diff --git a/dim b/dim
>> > index e0551ace54e4..3e82de96b4ab 100755
>> > --- a/dim
>> > +++ b/dim
>> > @@ -1293,6 +1293,9 @@ function dim_update_branches
>> >  	dim_checkout drm-intel-next
>> >  	$DRY git reset --hard $DIM_DRM_INTEL_REMOTE/drm-intel-next
>> >  
>> > +	cd $DIM_PREFIX/maintainer-tools
>> > +	git pull --rebase
>> > +
>> 
>> Ooops?
>
> From the commit message: "Also update the maintainer-tools branch, which
> is something Paulo's script also does." This way dim update-branches
> updates everything, and I think that's good, I liked that idea from
> Paulo's script a lot.

Oh. Didn't expect that in a patch with "update docs" as the title.

I often run dim with the changes I'm developing, using branches other
than maintainer-tools, so I'm not entirely thrilled.

BR,
Jani.



> -Daniel
>
>> 
>> 
>> >  	update_rerere_cache
>> >  }
>> >  
>> > diff --git a/dim.rst b/dim.rst
>> > index 0c52ab43e400..b9cb41a2ba5b 100644
>> > --- a/dim.rst
>> > +++ b/dim.rst
>> > @@ -74,11 +74,8 @@ Setup git maintainer branches in the given prefix.
>> >  
>> >  update-branches
>> >  ---------------
>> > -Updates all maintainer branches. Only needs to be run to synchronize branches
>> > -between different machines (or maintainers fwiw). As long a given branch is
>> > -always maintained from the same machine, even if different branches are
>> > -maintained on different machines (by different maintainers), there's no need to
>> > -run this command.
>> > +Updates all maintainer branches. Useful to synchronize all branches when other
>> > +maintainers and committers pushed patches meanwhile.
>> >  
>> >  status
>> >  ------
>> > @@ -408,6 +405,10 @@ corresponding to this repository is defined by DIM_DRM_INTEL in your .dimrc.
>> >  You should also have directories called maintainer-tools, drm-tip (for
>> >  rebuilding the tree), and drm-intel-rerere for some dim-internal book-keeping.
>> >  
>> > +If someone else has pushed patches first resync using::
>> > +
>> > +   $ dim update-branches
>> > +
>> >  Applying patches to dinq is done in the main repository with::
>> >  
>> >      $ cat patch.mbox | dim apply-queued
>> 
>> -- 
>> Jani Nikula, Intel Open Source Technology Center
Daniel Vetter Dec. 12, 2016, 9:20 a.m. UTC | #4
On Mon, Dec 12, 2016 at 10:14:29AM +0200, Jani Nikula wrote:
> On Fri, 09 Dec 2016, Daniel Vetter <daniel@ffwll.ch> wrote:
> > On Thu, Dec 08, 2016 at 11:53:07PM +0200, Jani Nikula wrote:
> >> On Thu, 08 Dec 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> >> > It's been years since drm-intel had only one maintainer, and the
> >> > primary use-case for dim ub was only to sync between machines. Update
> >> > the docs to reflect this, to avoid misleading committers. Also update
> >> > the maintainer-tools branch, which is something Paulo's script also
> >> > does.
> >> >
> >> > Motivated because Paulo typed an actualize.sh script which does
> >> > exactly what dim ub is meant to do.
> >> >
> >> > v2: Also update quickstart guide.
> >> >
> >> > v3: And spelling fixes.
> >> >
> >> > Acked-by: Paulo Zanoni <paulo.r.zanoni@intel.com>
> >> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> >> > ---
> >> >  dim     |  3 +++
> >> >  dim.rst | 11 ++++++-----
> >> >  2 files changed, 9 insertions(+), 5 deletions(-)
> >> >
> >> > diff --git a/dim b/dim
> >> > index e0551ace54e4..3e82de96b4ab 100755
> >> > --- a/dim
> >> > +++ b/dim
> >> > @@ -1293,6 +1293,9 @@ function dim_update_branches
> >> >  	dim_checkout drm-intel-next
> >> >  	$DRY git reset --hard $DIM_DRM_INTEL_REMOTE/drm-intel-next
> >> >  
> >> > +	cd $DIM_PREFIX/maintainer-tools
> >> > +	git pull --rebase
> >> > +
> >> 
> >> Ooops?
> >
> > From the commit message: "Also update the maintainer-tools branch, which
> > is something Paulo's script also does." This way dim update-branches
> > updates everything, and I think that's good, I liked that idea from
> > Paulo's script a lot.
> 
> Oh. Didn't expect that in a patch with "update docs" as the title.

Yeah, subject is misleading.

> I often run dim with the changes I'm developing, using branches other
> than maintainer-tools, so I'm not entirely thrilled.

Should I check whether it's still on the maintainer-tools branch and only
update if that's the case? That should cover all use-cases I hope ...
-Daniel
Jani Nikula Dec. 12, 2016, 10:43 a.m. UTC | #5
On Mon, 12 Dec 2016, Daniel Vetter <daniel@ffwll.ch> wrote:
> On Mon, Dec 12, 2016 at 10:14:29AM +0200, Jani Nikula wrote:
>> On Fri, 09 Dec 2016, Daniel Vetter <daniel@ffwll.ch> wrote:
>> > On Thu, Dec 08, 2016 at 11:53:07PM +0200, Jani Nikula wrote:
>> >> On Thu, 08 Dec 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>> >> > It's been years since drm-intel had only one maintainer, and the
>> >> > primary use-case for dim ub was only to sync between machines. Update
>> >> > the docs to reflect this, to avoid misleading committers. Also update
>> >> > the maintainer-tools branch, which is something Paulo's script also
>> >> > does.
>> >> >
>> >> > Motivated because Paulo typed an actualize.sh script which does
>> >> > exactly what dim ub is meant to do.
>> >> >
>> >> > v2: Also update quickstart guide.
>> >> >
>> >> > v3: And spelling fixes.
>> >> >
>> >> > Acked-by: Paulo Zanoni <paulo.r.zanoni@intel.com>
>> >> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
>> >> > ---
>> >> >  dim     |  3 +++
>> >> >  dim.rst | 11 ++++++-----
>> >> >  2 files changed, 9 insertions(+), 5 deletions(-)
>> >> >
>> >> > diff --git a/dim b/dim
>> >> > index e0551ace54e4..3e82de96b4ab 100755
>> >> > --- a/dim
>> >> > +++ b/dim
>> >> > @@ -1293,6 +1293,9 @@ function dim_update_branches
>> >> >  	dim_checkout drm-intel-next
>> >> >  	$DRY git reset --hard $DIM_DRM_INTEL_REMOTE/drm-intel-next
>> >> >  
>> >> > +	cd $DIM_PREFIX/maintainer-tools
>> >> > +	git pull --rebase
>> >> > +
>> >> 
>> >> Ooops?
>> >
>> > From the commit message: "Also update the maintainer-tools branch, which
>> > is something Paulo's script also does." This way dim update-branches
>> > updates everything, and I think that's good, I liked that idea from
>> > Paulo's script a lot.
>> 
>> Oh. Didn't expect that in a patch with "update docs" as the title.
>
> Yeah, subject is misleading.
>
>> I often run dim with the changes I'm developing, using branches other
>> than maintainer-tools, so I'm not entirely thrilled.
>
> Should I check whether it's still on the maintainer-tools branch and only
> update if that's the case? That should cover all use-cases I hope ...

That would work fine, thanks.

BR,
Jani.

> -Daniel
diff mbox

Patch

diff --git a/dim b/dim
index e0551ace54e4..3e82de96b4ab 100755
--- a/dim
+++ b/dim
@@ -1293,6 +1293,9 @@  function dim_update_branches
 	dim_checkout drm-intel-next
 	$DRY git reset --hard $DIM_DRM_INTEL_REMOTE/drm-intel-next
 
+	cd $DIM_PREFIX/maintainer-tools
+	git pull --rebase
+
 	update_rerere_cache
 }
 
diff --git a/dim.rst b/dim.rst
index 0c52ab43e400..b9cb41a2ba5b 100644
--- a/dim.rst
+++ b/dim.rst
@@ -74,11 +74,8 @@  Setup git maintainer branches in the given prefix.
 
 update-branches
 ---------------
-Updates all maintainer branches. Only needs to be run to synchronize branches
-between different machines (or maintainers fwiw). As long a given branch is
-always maintained from the same machine, even if different branches are
-maintained on different machines (by different maintainers), there's no need to
-run this command.
+Updates all maintainer branches. Useful to synchronize all branches when other
+maintainers and committers pushed patches meanwhile.
 
 status
 ------
@@ -408,6 +405,10 @@  corresponding to this repository is defined by DIM_DRM_INTEL in your .dimrc.
 You should also have directories called maintainer-tools, drm-tip (for
 rebuilding the tree), and drm-intel-rerere for some dim-internal book-keeping.
 
+If someone else has pushed patches first resync using::
+
+   $ dim update-branches
+
 Applying patches to dinq is done in the main repository with::
 
     $ cat patch.mbox | dim apply-queued