all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* [package-vc] Consider cleaning up files from install process
@ 2023-09-19  7:24 Joseph Turner
  2023-09-19  9:03 ` Philip Kaludercic
  2023-09-20 12:03 ` Stefan Monnier via Emacs development discussions.
  0 siblings, 2 replies; 17+ messages in thread
From: Joseph Turner @ 2023-09-19  7:24 UTC (permalink / raw)
  To: Emacs Devel Mailing List; +Cc: Philip Kaludercic, Adam Porter

package-vc-install currently adds a number of files to a package's
repository which are not tracked by VC.  It is inconvenience to add each
of them to a .gitignore file (or equivalent in other VC systems).  Are
they necessary?  Are you open to removing them in a clean up phase?

For example, when following these instructions to install hyperdrive.el:
https://ushin.org/hyperdrive/hyperdrive-manual.html#package_002dvc

the git repository ends up with these extra untracked files:

dir
hyperdrive-autoloads.el
hyperdrive-pkg.el
hyperdrive.info

Best,

Joseph



^ permalink raw reply	[flat|nested] 17+ messages in thread
* Re: [package-vc] Consider cleaning up files from install process
@ 2023-10-04  8:11 Joseph Turner
  0 siblings, 0 replies; 17+ messages in thread
From: Joseph Turner @ 2023-10-04  8:11 UTC (permalink / raw)
  To: monnier; +Cc: Philip Kaludercic, Adam Porter, Emacs Devel Mailing List

> > For example, when following these instructions to install hyperdrive.el:
> > https://ushin.org/hyperdrive/hyperdrive-manual.html#package_002dvc
> >
> > the git repository ends up with these extra untracked files:
> >
> > dir
> > hyperdrive-autoloads.el
> > hyperdrive-pkg.el
> > hyperdrive.info

> Please report this as a bug in the Hyperdrive repository: its
> `.gitignore` should be adjusted to ignore those files.

Good to know. We have updated the hyperdrive.el .gitignore.

Are all package authors are expected to add these files to .gitignore
(or equivalent in other VCS)?  If so, we should probably put a notice in
the package-vc documentation or somewhere else. What do you suggest?

Thank you!!

Joseph



^ permalink raw reply	[flat|nested] 17+ messages in thread
* Re: [package-vc] Consider cleaning up files from install process
@ 2023-10-04  8:22 Joseph Turner
  0 siblings, 0 replies; 17+ messages in thread
From: Joseph Turner @ 2023-10-04  8:22 UTC (permalink / raw)
  To: monnier; +Cc: Adam Porter, Philip Kaludercic, Emacs Devel Mailing List

> > In other words, the way package-vc-install currently works leaves me
> > vulnerable to this scenario:
> >
> > 1.  I use package-vc-install to install one of my packages from its local
> >    repository directory.
> > 2.  I check out a feature branch of that package to work on a new feature,
> >    saving some files but not loading any of the changed code.
> > 3.  I restart Emacs (e.g. maybe I shut down the system and turned it back on
> >    the next day).
> > 4.  That work-in-progress feature branch of my package gets loaded into
> >     Emacs automatically (which may be entirely broken, being a WIP).

> Not sure why you consider that a problem.  That's the whole purpose of
> installing straight from the VCS rather than from a tarball.

> If you don't want your Emacs to use that work-in-progress feature
> branch, then work on it elsewhere than in the VCS clone that was created
> specifically to be used in-place.
> E.g. use `git worktree`.

> > Philip, would you be willing to consider switching to that model for
> > package-vc-install, or offering it as an option?

> The option already exists, it's called `git worktree` :-)

I had not considered `git worktree` as a solution.  Very neat.

> Switching to "that model" wholesale would prevent the current use where
> you can edit the *live* files.

Thank you!

Joseph



^ permalink raw reply	[flat|nested] 17+ messages in thread
* Re: [package-vc] Consider cleaning up files from install process
@ 2023-10-04  8:31 Joseph Turner
  2023-10-04 15:23 ` Philip Kaludercic
  0 siblings, 1 reply; 17+ messages in thread
From: Joseph Turner @ 2023-10-04  8:31 UTC (permalink / raw)
  To: monnier; +Cc: Adam Porter, Philip Kaludercic, Emacs Devel Mailing List

> > For example, when following these instructions to install hyperdrive.el:
> > https://ushin.org/hyperdrive/hyperdrive-manual.html#package_002dvc
> >
> > the git repository ends up with these extra untracked files:
> >
> > dir
> > hyperdrive-autoloads.el
> > hyperdrive-pkg.el
> > hyperdrive.info

> Please report this as a bug in the Hyperdrive repository: its
> `.gitignore` should be adjusted to ignore those files.

Good to know. We have updated the hyperdrive.el .gitignore.

Are all package authors are expected to add these files to .gitignore
(or equivalent in other VCS)?  If so, we should probably put a notice in
the package-vc documentation or somewhere else.  What do you suggest?

Thank you!

Joseph



^ permalink raw reply	[flat|nested] 17+ messages in thread

end of thread, other threads:[~2023-10-07 13:31 UTC | newest]

Thread overview: 17+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-09-19  7:24 [package-vc] Consider cleaning up files from install process Joseph Turner
2023-09-19  9:03 ` Philip Kaludercic
2023-09-19 12:19   ` Adam Porter
2023-09-19 13:50     ` Philip Kaludercic
2023-09-19 14:34       ` Adam Porter
2023-09-20  8:13         ` Philip Kaludercic
2023-10-07  7:52           ` Adam Porter
2023-10-07 13:31             ` Philip Kaludercic
2023-09-20 12:13         ` Stefan Monnier via Emacs development discussions.
2023-09-20 12:08     ` Stefan Monnier via Emacs development discussions.
2023-09-20 12:03 ` Stefan Monnier via Emacs development discussions.
  -- strict thread matches above, loose matches on Subject: below --
2023-10-04  8:11 Joseph Turner
2023-10-04  8:22 Joseph Turner
2023-10-04  8:31 Joseph Turner
2023-10-04 15:23 ` Philip Kaludercic
2023-10-04 18:54   ` Joseph Turner
2023-10-06  9:00     ` Philip Kaludercic

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.