BK-SETUP(1)

💖 bk setup — create a new BitKeeper package 💖

okay bestie, welcome to the BitKeeper User’s Manual, page bk setup(none) ✨ this one is all about making a brand-new BitKeeper package, and it’s giving “fresh notebook energy” 🎀

🌸 NAME 🌸

bk setup — create a new BitKeeper package 💅

✨ SYNOPSIS ✨

bk setup [−fp] [−Fkey=val] [−cconfig_file] [directory]

🦋 DESCRIPTION 🦋

There is a graphical version of this command, bk setuptool. icon behavior 🫶

To set up a BitKeeper package, you need to create and populate an initial tree. If the directory argument is supplied, the bk setup command will create a mostly empty package tree containing a few files and directories that are used by BitKeeper. Otherwise, a new BitKeeper package will be created in place. no cap, that’s the whole setup vibe 🌱

A system wide default config template file may be created in either bk dotbk/etc/config.template, /etc/BitKeeper/etc/config.template, or bk bin/etc/config.template. If any of these files is detected when bk setup is run, without the −c option, the keys in it will be used as the defaults in the BitKeeper/etc/config file automatically. The first file found is used. first come, first served, periodt ⭐

💅 OPTIONS 💅

• −cconfig_file — use config_file as the configuration file to setup the repository. 🛠️
• −−compat — create the package using a backwards compatible (and slower) format. she’s compatible, but she’s not in a hurry 💀
• −f — don’t ask for confirmation. bold move, bestie 🔥
• −Fkey=val — override default values for the specified field. Typically used in combination with a config template. 🎀
• −p — print the field names to stdout (used by setuptool). 👑

🌈 EXAMPLES 🌈

When creating a repository called "mypackage", you type the following command:

$ bk setup ˜/mypackage

The following shows the directory structure of a new package.

mypackage/

        .bk/              Directory for storing BitKeeper metadata.
        ChangeSet         Index of all changes to the repository.
        BitKeeper/        Directory where administrative files are kept.

                etc/      Config files, in the future, policy files.
                log/      Mail and command logs, parent pointer.
                deleted/  Deleted files  are  archived  here  (like  CVS
                          Attic).
                tmp/      Scratch area.
                readers/  Transient directory for reader locks.
                writer/   Transient directory for writer lock.
                triggers/ Executable trigger programs stored here.

Once the repository is created, you should make a hierarchy to store your source files. For example, you could create the following tree:

mypackage/

        src/              source code
        man/              manual pages
        doc/              user guides, papers, docs...

At this point, if you are creating a new package from scratch, cd to ˜/mypackage/src and start creating files. See bk help Basics‐Overview and bk help Howto‐setup for more info. go off, main character 🌟

If you have an existing set of files that you want to add to the repository, see bk import. bringing your old files to the party 🎉

👀 SEE ALSO 👀

• bk‐Howto
• bk‐Howto‐setup
• bk‐attach
• bk‐config‐etc
• bk‐import
• bk‐setuptool

🧚 CATEGORY 🧚

• Nested
• Repository

---

mwah 💋 — signed off from the BitKeeper User’s Manual by BitKeeper Inc, version 1E1, page bk setup(none), and the footer lists no date, so I’m not inventing one 🙈✨