Update docs for darcs->git switch, and switch from darcs-rev to gitrev

This commit is contained in:
Pere Lev 2023-05-25 13:54:03 +03:00
parent 1fadb2a07e
commit 906b5e8f44
No known key found for this signature in database
GPG key ID: 5252C5C863E5E57D
7 changed files with 30 additions and 51 deletions

View file

@ -41,25 +41,19 @@ instructions.
# (3) Version control systems Darcs and Git # (3) Version control systems Darcs and Git
Install Darcs. You can grab it from your distro, e.g.: Install Darcs and Git. You can grab them from your distro, e.g.:
$ sudo apt install darcs $ sudo apt install darcs git
If you're going to create a Git repository on Vervis, you'll need Git too, you
can install it from a distro package too, e.g.:
$ sudo apt install git
# (4) The Vervis source code # (4) The Vervis source code
Clone the Vervis repo: Clone the Vervis repo:
$ darcs clone https://vervis.peers.community/repos/WvWbo vervis $ git clone https://vervis.peers.community/repos/rjQ3E vervis
$ cd vervis $ cd vervis
Clone dependency libraries: Clone dependency libraries:
$ chmod u+x update-deps.sh
$ ./update-deps.sh $ ./update-deps.sh
# (5) Database # (5) Database
@ -128,7 +122,7 @@ you're keeping the default name:
To update your local clone of Vervis, run: To update your local clone of Vervis, run:
$ darcs pull $ git pull
$ ./update-deps.sh $ ./update-deps.sh
$ stack build $ stack build

View file

@ -66,7 +66,7 @@ Once you create a repository, it is possible that initially, trying to look at
it will give you 404. It should be okay though once you push some commit into it will give you 404. It should be okay though once you push some commit into
it. it.
The examples below use Darcs, but it's exactly the same for Git. They are The examples below use Git, but it's exactly the same for Darcs. They are
equally supported. equally supported.
Cloning repositories works over (unauthenticated) HTTPS and (authenticated) Cloning repositories works over (unauthenticated) HTTPS and (authenticated)
@ -74,17 +74,17 @@ SSH.
**HTTPS clone:** **HTTPS clone:**
$ darcs clone https://vervis.peers.community/repos/WvWbo vervis $ git clone https://vervis.peers.community/repos/rjQ3E vervis
**SSH clone and push:** **SSH clone and push:**
If your system username and Vervis username are identical: If your system username and Vervis username are identical:
$ darcs clone vervis.peers.community:WvWbo vervis $ git clone vervis.peers.community:rjQ3E vervis
If usernames are different: If usernames are different:
$ darcs clone luke@vervis.peers.community:WvWbo vervis $ git clone luke@vervis.peers.community:rjQ3E vervis
A few more little notes: A few more little notes:
@ -225,11 +225,11 @@ control.
The official download location is the Darcs repository: The official download location is the Darcs repository:
<https://vervis.peers.community/repos/WvWbo> <https://vervis.peers.community/repos/rjQ3E>
There is a backup repo, not always up to date though, at: There is a backup repo, not always up to date though, at:
<https://hub.darcs.net/fr33domlover/vervis> <https://codeberg.org/forgefed/vervis>
See the file `INSTALL.md` for a detailed usage and deployment guide. The file See the file `INSTALL.md` for a detailed usage and deployment guide. The file
`ChangeLog` explains how to see the history log of the changes done in the `ChangeLog` explains how to see the history log of the changes done in the
@ -244,8 +244,8 @@ Folders:
- `config`: - `config`:
Settings the app reads when it launches, some defined by a human and some Settings the app reads when it launches, some defined by a human and some
auto-generated auto-generated
- `_darcs`: - `.git`:
Internal version control data of this repo, similar to a `.git` directory Internal version control data of this repo
- `embed`: - `embed`:
Files embedded into the app source code at build time (using TH) Files embedded into the app source code at build time (using TH)
- `hook-darcs` & `hook-git`: - `hook-darcs` & `hook-git`:
@ -269,7 +269,7 @@ Folders:
Files: Files:
- `_boring` - `.gitignore`
- `th/routes` - `th/routes`
- `th/models` - `th/models`
- `update-deps.sh` - `update-deps.sh`
@ -306,9 +306,8 @@ solve it.
If you're going to implement some feature or fix some bug you found, **start by If you're going to implement some feature or fix some bug you found, **start by
opening a ticket** opening a ticket**
[here](https://vervis.peers.community/s/fr33domlover/p/vervis/t) so that other [here](https://vervis.peers.community/decks/br6Go) so that other
people will know which features are being developed and who does what. people will know which features are being developed and who does what.
UPDATE: The ticket tracker is temporarily unavailable. You can instead contact UPDATE: The ticket tracker is temporarily unavailable. You can instead contact
[fr33domlover](https://fr33domlover.site) to report issues and to coordinate [Pere](https://perelev.site) to report issues and to coordinate work.
work.

View file

@ -1,6 +1,6 @@
{- This file is part of Vervis. {- This file is part of Vervis.
- -
- Written in 2016, 2018, 2019 by fr33domlover <fr33domlover@riseup.net>. - Written in 2016, 2018, 2019, 2023 by fr33domlover <fr33domlover@riseup.net>.
- -
- Copying is an act of love. Please copy, reuse and share. - Copying is an act of love. Please copy, reuse and share.
- -
@ -25,7 +25,7 @@ where
import Data.Text (Text) import Data.Text (Text)
import Data.Time.Calendar (toGregorian) import Data.Time.Calendar (toGregorian)
import Data.Time.Clock (UTCTime (..)) import Data.Time.Clock (UTCTime (..))
import Development.Darcs.Rev import Development.GitRev
import Formatting (sformat, (%), int, left) import Formatting (sformat, (%), int, left)
import Network.HTTP.Types.Method import Network.HTTP.Types.Method
import Yesod.Core import Yesod.Core
@ -45,11 +45,10 @@ breadcrumbsW = do
revisionW :: WidgetFor site () revisionW :: WidgetFor site ()
revisionW = revisionW =
let cgTimeFmt = showDate . cgTime let rev = $gitDescribe :: Text
mrev = $darcsRevision address = "^rjQ3E@vervis.peers.community" :: Text
address = "^WvWbo@vervis.peers.community" :: Text link = "https://vervis.peers.community/repos/rjQ3E" :: Text
link = "https://vervis.peers.community/repos/WvWbo" :: Text changes = $gitCommitCount :: Text
changes = $darcsTotalPatches :: Int
in $(widgetFile "widget/revision") in $(widgetFile "widget/revision")
avatarW :: Bool -> Text -> WidgetFor site () avatarW :: Bool -> Text -> WidgetFor site ()

View file

@ -22,7 +22,6 @@ extra-deps:
# - persistent-postgresql # - persistent-postgresql
- ./lib/darcs-lights - ./lib/darcs-lights
- ./lib/darcs-rev
- ./lib/dvara - ./lib/dvara
- ./lib/ssh - ./lib/ssh
- ./lib/hit-graph - ./lib/hit-graph

View file

@ -1,6 +1,6 @@
$# This file is part of Vervis. $# This file is part of Vervis.
$# $#
$# Written in 2016, 2022 by fr33domlover <fr33domlover@riseup.net>. $# Written in 2016, 2022, 2023 by fr33domlover <fr33domlover@riseup.net>.
$# $#
$# ♡ Copying is an act of love. Please copy, reuse and share. $# ♡ Copying is an act of love. Please copy, reuse and share.
$# $#
@ -16,15 +16,4 @@ $# <http://creativecommons.org/publicdomain/zero/1.0/>.
#{address} #{address}
» # » #
$maybe rev <- mrev #{rev} (total: #{changes} patches)
$case rev
$of RevTag t
#{cgTitle t} #{cgTimeFmt t}
$of RevTagPlus t n p
#{cgTitle t} + #{n} patches (#{T.take 10 $ cgHash p} #{cgTimeFmt p})
$of RevPatch p
#{T.take 10 $ cgHash p} #{cgTimeFmt p}
\ (total: #{changes} patches)
$nothing
(unknown revision)

View file

@ -7,7 +7,6 @@ DEPS="vlBxr dvara \n
RvP1E hit-harder \n RvP1E hit-harder \n
rL9jo hit-network \n rL9jo hit-network \n
9EmyE darcs-lights \n 9EmyE darcs-lights \n
Orj3o darcs-rev \n
v3e8r http-client-signature \n v3e8r http-client-signature \n
vM99v http-signature \n vM99v http-signature \n
6r4Ao ssh \n 6r4Ao ssh \n

View file

@ -8,12 +8,12 @@ description:
Most of the source code is in the public domain using the CC0 public domain Most of the source code is in the public domain using the CC0 public domain
dedication, but the application as a whole has GPL dependencies, and is dedication, but the application as a whole has GPL dependencies, and is
released under the AGPL 3 license. released under the AGPL 3 license.
homepage: https://vervis.peers.community/repos/WvWbo homepage: https://vervis.peers.community/repos/rjQ3E
bug-reports: fr33domlover@riseup.net bug-reports: pere@towards.vision
license: AGPL-3 license: AGPL-3
license-file: COPYING.AGPL3 license-file: COPYING.AGPL3
author: fr33domlover author: Pere Lev
maintainer: fr33domlover@riseup.net maintainer: pere@towards.vision
copyright: ♡ Copying is an act of love. Please copy, reuse and share. copyright: ♡ Copying is an act of love. Please copy, reuse and share.
category: Development, Distribution, Git, Web category: Development, Distribution, Git, Web
build-type: Simple build-type: Simple
@ -26,8 +26,8 @@ extra-source-files: AUTHORS.md
cabal-version: >=1.10 cabal-version: >=1.10
source-repository head source-repository head
type: darcs type: git
location: https://vervis.peers.community/repos/WvWbo location: https://vervis.peers.community/repos/rjQ3E
flag dev flag dev
description: Turn on development settings, like auto-reload templates. description: Turn on development settings, like auto-reload templates.
@ -327,7 +327,6 @@ library
-- unmaintained and darcs has its own copy -- unmaintained and darcs has its own copy
, darcs , darcs
, darcs-lights , darcs-lights
, darcs-rev
, data-default , data-default
, data-default-class , data-default-class
, data-default-instances-bytestring , data-default-instances-bytestring
@ -361,6 +360,7 @@ library
, html-entities , html-entities
, http-signature , http-signature
, git , git
, gitrev
, hit-graph , hit-graph
, hit-harder , hit-harder
, hit-network , hit-network