libgit2/include/git2/repository.h at main · libgit2/libgit2 · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

* This file is part of libgit2, distributed under the GNU GPL v2 with

* a Linking Exception. For full terms see the included COPYING file.

#ifndef INCLUDE_git_repository_h__

#define INCLUDE_git_repository_h__

#include "common.h"

#include "types.h"

#include "oid.h"

#include "odb.h"

#include "refdb.h"

#include "buffer.h"

#include "commit.h"

/**

* @file git2/repository.h

* @brief The repository stores revisions for a source tree

* @defgroup git_repository The repository stores revisions for a source tree

* @ingroup Git

* @{

GIT_BEGIN_DECL

/**

* Open a git repository.

* The 'path' argument must point to either a git repository

* folder, or an existing work dir.

* The method will automatically detect if 'path' is a normal

* or bare repository or fail is 'path' is neither.

* Note that the libgit2 library _must_ be initialized using

* `git_libgit2_init` before any APIs can be called, including

* this one.

* @param[out] out pointer to the repo which will be opened

* @param path the path to the repository

* @return 0 or an error code

GIT_EXTERN(int) git_repository_open(git_repository **out, const char *path);

/**

* Open working tree as a repository

* Open the working directory of the working tree as a normal

* repository that can then be worked on.

* @param[out] out Output pointer containing opened repository

* @param wt Working tree to open

* @return 0 or an error code

GIT_EXTERN(int) git_repository_open_from_worktree(

git_repository **out,

git_worktree *wt);

/**

* Create a "fake" repository to wrap an object database

* Create a repository object to wrap an object database to be used

* with the API when all you have is an object database. This doesn't

* have any paths associated with it, so use with care.

* @param[out] out pointer to the repo

* @param odb the object database to wrap

* @return 0 or an error code

GIT_EXTERN(int) git_repository_wrap_odb(

git_repository **out,

git_odb *odb);

/**

* Look for a git repository and copy its path in the given buffer.

* The lookup start from base_path and walk across parent directories

* if nothing has been found. The lookup ends when the first repository

* is found, or when reaching a directory referenced in ceiling_dirs

* or when the filesystem changes (in case across_fs is true).

* The method will automatically detect if the repository is bare

* (if there is a repository).

* Note that the libgit2 library _must_ be initialized using

* `git_libgit2_init` before any APIs can be called, including

* this one.

* @param out A pointer to a user-allocated git_buf which will contain

* the found path.

* @param start_path The base path where the lookup starts.

* @param across_fs If true, then the lookup will not stop when a

* filesystem device change is detected while exploring parent directories.

* @param ceiling_dirs A GIT_PATH_LIST_SEPARATOR separated list of

* absolute symbolic link free paths. The lookup will stop when any

* of this paths is reached. Note that the lookup always performs on

* start_path no matter start_path appears in ceiling_dirs ceiling_dirs

* might be NULL (which is equivalent to an empty string)

* @return 0 or an error code

GIT_EXTERN(int) git_repository_discover(

git_buf *out,

const char *start_path,

int across_fs,

const char *ceiling_dirs);

/**

* Option flags for `git_repository_open_ext`.

typedef enum {

/**

* Only open the repository if it can be immediately found in the

* start_path. Do not walk up from the start_path looking at parent

* directories.

GIT_REPOSITORY_OPEN_NO_SEARCH = (1 << 0),

/**

* Unless this flag is set, open will not continue searching across

* filesystem boundaries (i.e. when `st_dev` changes from the `stat`

* system call). For example, searching in a user's home directory at

* "/home/user/source/" will not return "/.git/" as the found repo if

* "/" is a different filesystem than "/home".

GIT_REPOSITORY_OPEN_CROSS_FS = (1 << 1),

/**

* Open repository as a bare repo regardless of core.bare config, and

* defer loading config file for faster setup.

* Unlike `git_repository_open_bare`, this can follow gitlinks.

GIT_REPOSITORY_OPEN_BARE = (1 << 2),

/**

* Do not check for a repository by appending /.git to the start_path;

* only open the repository if start_path itself points to the git

* directory.

GIT_REPOSITORY_OPEN_NO_DOTGIT = (1 << 3),

/**

* Find and open a git repository, respecting the environment variables

* used by the git command-line tools.

* If set, `git_repository_open_ext` will ignore the other flags and

* the `ceiling_dirs` argument, and will allow a NULL `path` to use

* `GIT_DIR` or search from the current directory.

* The search for a repository will respect $GIT_CEILING_DIRECTORIES and

* $GIT_DISCOVERY_ACROSS_FILESYSTEM. The opened repository will

* respect $GIT_INDEX_FILE, $GIT_NAMESPACE, $GIT_OBJECT_DIRECTORY, and

* $GIT_ALTERNATE_OBJECT_DIRECTORIES.

* In the future, this flag will also cause `git_repository_open_ext`

* to respect $GIT_WORK_TREE and $GIT_COMMON_DIR; currently,

* `git_repository_open_ext` with this flag will error out if either

* $GIT_WORK_TREE or $GIT_COMMON_DIR is set.

GIT_REPOSITORY_OPEN_FROM_ENV = (1 << 4)

} git_repository_open_flag_t;

/**

* Find and open a repository with extended controls.

* Note that the libgit2 library _must_ be initialized using

* `git_libgit2_init` before any APIs can be called, including

* this one.

* @param[out] out Pointer to the repo which will be opened. This can

* actually be NULL if you only want to use the error code to

* see if a repo at this path could be opened.

* @param path Path to open as git repository. If the flags

* permit "searching", then this can be a path to a subdirectory

* inside the working directory of the repository. May be NULL if

* flags is GIT_REPOSITORY_OPEN_FROM_ENV.

* @param flags A combination of the GIT_REPOSITORY_OPEN flags above.

* @param ceiling_dirs A GIT_PATH_LIST_SEPARATOR delimited list of path

* prefixes at which the search for a containing repository should

* terminate.

* @return 0 on success, GIT_ENOTFOUND if no repository could be found,

* or -1 if there was a repository but open failed for some reason

* (such as repo corruption or system errors).

GIT_EXTERN(int) git_repository_open_ext(

git_repository **out,

const char *path,

unsigned int flags,

const char *ceiling_dirs);

/**

* Open a bare repository on the serverside.

* This is a fast open for bare repositories that will come in handy

* if you're e.g. hosting git repositories and need to access them

* efficiently

* Note that the libgit2 library _must_ be initialized using

* `git_libgit2_init` before any APIs can be called, including

* this one.

* @param[out] out Pointer to the repo which will be opened.

* @param bare_path Direct path to the bare repository

* @return 0 on success, or an error code

GIT_EXTERN(int) git_repository_open_bare(git_repository **out, const char *bare_path);

/**

* Free a previously allocated repository

* Note that after a repository is free'd, all the objects it has spawned

* will still exist until they are manually closed by the user

* with `git_object_free`, but accessing any of the attributes of

* an object without a backing repository will result in undefined

* behavior

* @param repo repository handle to close. If NULL nothing occurs.

GIT_EXTERN(void) git_repository_free(git_repository *repo);

/**

* Creates a new Git repository in the given folder.

* TODO:

* - Reinit the repository

* Note that the libgit2 library _must_ be initialized using

* `git_libgit2_init` before any APIs can be called, including

* this one.

* @param[out] out pointer to the repo which will be created or reinitialized

* @param path the path to the repository

* @param is_bare if true, a Git repository without a working directory is

* created at the pointed path. If false, provided path will be

* considered as the working directory into which the .git directory

* will be created.

* @return 0 or an error code

GIT_EXTERN(int) git_repository_init(

git_repository **out,

const char *path,

unsigned is_bare);

/**

* Option flags for `git_repository_init_ext`.

* These flags configure extra behaviors to `git_repository_init_ext`.

* In every case, the default behavior is the zero value (i.e. flag is

* not set). Just OR the flag values together for the `flags` parameter

* when initializing a new repo.

typedef enum {

/**

* Create a bare repository with no working directory.

GIT_REPOSITORY_INIT_BARE = (1u << 0),

/**

* Return an GIT_EEXISTS error if the repo_path appears to already be

* an git repository.

GIT_REPOSITORY_INIT_NO_REINIT = (1u << 1),

/**

* Make the repo_path (and workdir_path) as needed. Init is always willing

* to create the ".git" directory even without this flag. This flag tells

* init to create the trailing component of the repo and workdir paths

* as needed.

GIT_REPOSITORY_INIT_MKDIR = (1u << 3),

/**

* Recursively make all components of the repo and workdir paths as

* necessary.

GIT_REPOSITORY_INIT_MKPATH = (1u << 4),

/**

* libgit2 normally uses internal templates to initialize a new repo.

* This flags enables external templates, looking the "template_path" from

* the options if set, or the `init.templatedir` global config if not,

* or falling back on "/usr/share/git-core/templates" if it exists.

GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE = (1u << 5),

/**

* If an alternate workdir is specified, use relative paths for the gitdir

* and core.worktree.

GIT_REPOSITORY_INIT_RELATIVE_GITLINK = (1u << 6)

} git_repository_init_flag_t;

/**

* Mode options for `git_repository_init_ext`.

* Set the mode field of the `git_repository_init_options` structure

* either to the custom mode that you would like, or to one of the

* defined modes.

typedef enum {

/**

* Use permissions configured by umask - the default.

GIT_REPOSITORY_INIT_SHARED_UMASK = 0,

/**

* Use "--shared=group" behavior, chmod'ing the new repo to be group

* writable and "g+sx" for sticky group assignment.

GIT_REPOSITORY_INIT_SHARED_GROUP = 0002775,

/**

* Use "--shared=all" behavior, adding world readability.

GIT_REPOSITORY_INIT_SHARED_ALL = 0002777

} git_repository_init_mode_t;

/**

* Extended options structure for `git_repository_init_ext`.

* This contains extra options for `git_repository_init_ext` that enable

* additional initialization features.

* @options[version] GIT_REPOSITORY_INIT_OPTIONS_VERSION

* @options[init_macro] GIT_REPOSITORY_INIT_OPTIONS_INIT

* @options[init_function] git_repository_init_options_init

typedef struct {

unsigned int version;

/**

* Combination of GIT_REPOSITORY_INIT flags above.

uint32_t flags;

/**

* Set to one of the standard GIT_REPOSITORY_INIT_SHARED_... constants

* above, or to a custom value that you would like.

uint32_t mode;

/**

* The path to the working dir or NULL for default (i.e. repo_path parent

* on non-bare repos). IF THIS IS RELATIVE PATH, IT WILL BE EVALUATED

* RELATIVE TO THE REPO_PATH. If this is not the "natural" working

* directory, a .git gitlink file will be created here linking to the

* repo_path.

const char *workdir_path;

/**

* If set, this will be used to initialize the "description" file in the

* repository, instead of using the template content.

const char *description;

/**

* When GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE is set, this contains

* the path to use for the template directory. If this is NULL, the config

* or default directory options will be used instead.

const char *template_path;

/**

* The name of the head to point HEAD at. If NULL, then this will be

* treated as "master" and the HEAD ref will be set to "refs/heads/master".

* If this begins with "refs/" it will be used verbatim;

* otherwise "refs/heads/" will be prefixed.

const char *initial_head;

/**

* If this is non-NULL, then after the rest of the repository

* initialization is completed, an "origin" remote will be added

* pointing to this URL.

const char *origin_url;

/**

* Type of object IDs to use for this repository, or 0 for

* default (currently SHA1).

git_oid_t oid_type;

/**

* Type of the reference database to use for this repository, or 0 for

* default (currently "files").

git_refdb_t refdb_type;

} git_repository_init_options;

/** Current version for the `git_repository_init_options` structure */

#define GIT_REPOSITORY_INIT_OPTIONS_VERSION 1

/** Static constructor for `git_repository_init_options` */

#define GIT_REPOSITORY_INIT_OPTIONS_INIT {GIT_REPOSITORY_INIT_OPTIONS_VERSION}

/**

* Initialize git_repository_init_options structure

* Initializes a `git_repository_init_options` with default values. Equivalent to

* creating an instance with `GIT_REPOSITORY_INIT_OPTIONS_INIT`.

* @param opts The `git_repository_init_options` struct to initialize.

* @param version The struct version; pass `GIT_REPOSITORY_INIT_OPTIONS_VERSION`.

* @return Zero on success; -1 on failure.

GIT_EXTERN(int) git_repository_init_options_init(

git_repository_init_options *opts,

unsigned int version);

/**

* Create a new Git repository in the given folder with extended controls.

* This will initialize a new git repository (creating the repo_path

* if requested by flags) and working directory as needed. It will

* auto-detect the case sensitivity of the file system and if the

* file system supports file mode bits correctly.

* Note that the libgit2 library _must_ be initialized using

* `git_libgit2_init` before any APIs can be called, including

* this one.

* @param[out] out Pointer to the repo which will be created or reinitialized.

* @param repo_path The path to the repository.

* @param opts Pointer to git_repository_init_options struct.

* @return 0 or an error code on failure.

GIT_EXTERN(int) git_repository_init_ext(

git_repository **out,

const char *repo_path,

git_repository_init_options *opts);

/**

* Retrieve and resolve the reference pointed at by HEAD.

* The returned `git_reference` will be owned by caller and

* `git_reference_free()` must be called when done with it to release the

* allocated memory and prevent a leak.

* @param[out] out pointer to the reference which will be retrieved

* @param repo a repository object

* @return 0 on success, GIT_EUNBORNBRANCH when HEAD points to a non existing

* branch, GIT_ENOTFOUND when HEAD is missing; an error code otherwise

GIT_EXTERN(int) git_repository_head(git_reference **out, git_repository *repo);

/**

* Retrieve the referenced HEAD for the worktree

* @param[out] out pointer to the reference which will be retrieved

* @param repo a repository object

* @param name name of the worktree to retrieve HEAD for

* @return 0 when successful, error-code otherwise

GIT_EXTERN(int) git_repository_head_for_worktree(

git_reference **out,

git_repository *repo,

const char *name);

/**

* Check if a repository's HEAD is detached

* A repository's HEAD is detached when it points directly to a commit

* instead of a branch.

* @param repo Repo to test

* @return 1 if HEAD is detached, 0 if it's not; error code if there

* was an error.

GIT_EXTERN(int) git_repository_head_detached(git_repository *repo);

/**

* Check if a worktree's HEAD is detached

* A worktree's HEAD is detached when it points directly to a

* commit instead of a branch.

* @param repo a repository object

* @param name name of the worktree to retrieve HEAD for

* @return 1 if HEAD is detached, 0 if its not; error code if

* there was an error

GIT_EXTERN(int) git_repository_head_detached_for_worktree(git_repository *repo,

const char *name);

/**

* Check if the current branch is unborn

* An unborn branch is one named from HEAD but which doesn't exist in

* the refs namespace, because it doesn't have any commit to point to.

* @param repo Repo to test

* @return 1 if the current branch is unborn, 0 if it's not; error

* code if there was an error

GIT_EXTERN(int) git_repository_head_unborn(git_repository *repo);

/**

* Check if a repository is empty

* An empty repository has just been initialized and contains no references

* apart from HEAD, which must be pointing to the unborn master branch,

* or the branch specified for the repository in the `init.defaultBranch`

* configuration variable.

* @param repo Repo to test

* @return 1 if the repository is empty, 0 if it isn't, error code

* if the repository is corrupted

GIT_EXTERN(int) git_repository_is_empty(git_repository *repo);

/**

* List of items which belong to the git repository layout

typedef enum {

GIT_REPOSITORY_ITEM_GITDIR,

GIT_REPOSITORY_ITEM_WORKDIR,

GIT_REPOSITORY_ITEM_COMMONDIR,

GIT_REPOSITORY_ITEM_INDEX,

GIT_REPOSITORY_ITEM_OBJECTS,

GIT_REPOSITORY_ITEM_REFS,

GIT_REPOSITORY_ITEM_PACKED_REFS,

GIT_REPOSITORY_ITEM_REMOTES,

GIT_REPOSITORY_ITEM_CONFIG,

GIT_REPOSITORY_ITEM_INFO,

GIT_REPOSITORY_ITEM_HOOKS,

GIT_REPOSITORY_ITEM_LOGS,

GIT_REPOSITORY_ITEM_MODULES,

GIT_REPOSITORY_ITEM_WORKTREES,

GIT_REPOSITORY_ITEM_WORKTREE_CONFIG,

GIT_REPOSITORY_ITEM__LAST

} git_repository_item_t;

/**

* Get the location of a specific repository file or directory

* This function will retrieve the path of a specific repository

* item. It will thereby honor things like the repository's

* common directory, gitdir, etc. In case a file path cannot

* exist for a given item (e.g. the working directory of a bare

* repository), GIT_ENOTFOUND is returned.

* @param out Buffer to store the path at

* @param repo Repository to get path for

* @param item The repository item for which to retrieve the path

* @return 0, GIT_ENOTFOUND if the path cannot exist or an error code

GIT_EXTERN(int) git_repository_item_path(git_buf *out, const git_repository *repo, git_repository_item_t item);

/**

* Get the path of this repository

* This is the path of the `.git` folder for normal repositories,

* or of the repository itself for bare repositories.

* @param repo A repository object

* @return the path to the repository

GIT_EXTERN(const char *) git_repository_path(const git_repository *repo);

/**

* Get the path of the working directory for this repository

* If the repository is bare, this function will always return

* NULL.

* @param repo A repository object

* @return the path to the working dir, if it exists

GIT_EXTERN(const char *) git_repository_workdir(const git_repository *repo);

/**

* Get the path of the shared common directory for this repository.

* If the repository is bare, it is the root directory for the repository.

* If the repository is a worktree, it is the parent repo's gitdir.

* Otherwise, it is the gitdir.

* @param repo A repository object

* @return the path to the common dir

GIT_EXTERN(const char *) git_repository_commondir(const git_repository *repo);

/**

* Set the path to the working directory for this repository

* The working directory doesn't need to be the same one

* that contains the `.git` folder for this repository.

* If this repository is bare, setting its working directory

* will turn it into a normal repository, capable of performing

* all the common workdir operations (checkout, status, index

* manipulation, etc).

* @param repo A repository object

* @param workdir The path to a working directory

* @param update_gitlink Create/update gitlink in workdir and set config

* "core.worktree" (if workdir is not the parent of the .git directory)

* @return 0, or an error code

GIT_EXTERN(int) git_repository_set_workdir(

git_repository *repo, const char *workdir, int update_gitlink);

/**

* Check if a repository is bare

* @param repo Repo to test

* @return 1 if the repository is bare, 0 otherwise.

GIT_EXTERN(int) git_repository_is_bare(const git_repository *repo);

/**

* Check if a repository is a linked work tree

* @param repo Repo to test

* @return 1 if the repository is a linked work tree, 0 otherwise.

GIT_EXTERN(int) git_repository_is_worktree(const git_repository *repo);

/**

* Get the configuration file for this repository.

* If a configuration file has not been set, the default

* config set for the repository will be returned, including

* global and system configurations (if they are available).

* The configuration file must be freed once it's no longer

* being used by the user.

* @param[out] out Pointer to store the loaded configuration

* @param repo A repository object

* @return 0, or an error code

GIT_EXTERN(int) git_repository_config(

git_config **out,

git_repository *repo);

/**

* Get a snapshot of the repository's configuration

* Convenience function to take a snapshot from the repository's

* configuration. The contents of this snapshot will not change,

* even if the underlying config files are modified.

* The configuration file must be freed once it's no longer

* being used by the user.

* @param[out] out Pointer to store the loaded configuration

* @param repo the repository

* @return 0, or an error code

GIT_EXTERN(int) git_repository_config_snapshot(

git_config **out,

git_repository *repo);

/**

* Get the Object Database for this repository.

* If a custom ODB has not been set, the default

* database for the repository will be returned (the one

* located in `.git/objects`).

* The ODB must be freed once it's no longer being used by

* the user.

* @param[out] out Pointer to store the loaded ODB

* @param repo A repository object

* @return 0, or an error code

GIT_EXTERN(int) git_repository_odb(git_odb **out, git_repository *repo);

/**

* Get the Reference Database Backend for this repository.

* If a custom refsdb has not been set, the default database for

* the repository will be returned (the one that manipulates loose

* and packed references in the `.git` directory).

* The refdb must be freed once it's no longer being used by

* the user.

* @param[out] out Pointer to store the loaded refdb

* @param repo A repository object

* @return 0, or an error code

GIT_EXTERN(int) git_repository_refdb(git_refdb **out, git_repository *repo);

/**

* Get the Index file for this repository.

* If a custom index has not been set, the default

* index for the repository will be returned (the one

* located in `.git/index`).

* The index must be freed once it's no longer being used by

* the user.

* @param[out] out Pointer to store the loaded index

* @param repo A repository object

* @return 0, or an error code

GIT_EXTERN(int) git_repository_index(git_index **out, git_repository *repo);

/**

* Retrieve git's prepared message

* Operations such as git revert/cherry-pick/merge with the -n option

* stop just short of creating a commit with the changes and save

* their prepared message in .git/MERGE_MSG so the next git-commit

* execution can present it to the user for them to amend if they

* wish.

* Use this function to get the contents of this file. Don't forget to

* remove the file after you create the commit.

* @param out git_buf to write data into

* @param repo Repository to read prepared message from

* @return 0, GIT_ENOTFOUND if no message exists or an error code

GIT_EXTERN(int) git_repository_message(git_buf *out, git_repository *repo);

/**

* Remove git's prepared message.

* Remove the message that `git_repository_message` retrieves.

* @param repo Repository to remove prepared message from.

* @return 0 or an error code.

GIT_EXTERN(int) git_repository_message_remove(git_repository *repo);

/**

* Remove all the metadata associated with an ongoing command like merge,

* revert, cherry-pick, etc. For example: MERGE_HEAD, MERGE_MSG, etc.

* @param repo A repository object

* @return 0 on success, or error

GIT_EXTERN(int) git_repository_state_cleanup(git_repository *repo);

/**

* Callback used to iterate over each FETCH_HEAD entry

* @see git_repository_fetchhead_foreach

* @param ref_name The reference name

* @param remote_url The remote URL

* @param oid The reference target OID

* @param is_merge Was the reference the result of a merge

* @param payload Payload passed to git_repository_fetchhead_foreach

* @return non-zero to terminate the iteration

typedef int GIT_CALLBACK(git_repository_fetchhead_foreach_cb)(const char *ref_name,

const char *remote_url,

const git_oid *oid,

unsigned int is_merge,

void *payload);

/**

* Invoke 'callback' for each entry in the given FETCH_HEAD file.

* Return a non-zero value from the callback to stop the loop.

* @param repo A repository object

* @param callback Callback function

* @param payload Pointer to callback data (optional)

* @return 0 on success, non-zero callback return value, GIT_ENOTFOUND if

* there is no FETCH_HEAD file, or other error code.

GIT_EXTERN(int) git_repository_fetchhead_foreach(

git_repository *repo,

git_repository_fetchhead_foreach_cb callback,

void *payload);

/**

* Callback used to iterate over each MERGE_HEAD entry

* @see git_repository_mergehead_foreach

* @param oid The merge OID

* @param payload Payload passed to git_repository_mergehead_foreach

* @return non-zero to terminate the iteration

typedef int GIT_CALLBACK(git_repository_mergehead_foreach_cb)(const git_oid *oid,

void *payload);

/**

* If a merge is in progress, invoke 'callback' for each commit ID in the

* MERGE_HEAD file.

* Return a non-zero value from the callback to stop the loop.

* @param repo A repository object

* @param callback Callback function

* @param payload Pointer to callback data (optional)

* @return 0 on success, non-zero callback return value, GIT_ENOTFOUND if

* there is no MERGE_HEAD file, or other error code.

GIT_EXTERN(int) git_repository_mergehead_foreach(

git_repository *repo,

git_repository_mergehead_foreach_cb callback,

void *payload);

/**

* Calculate hash of file using repository filtering rules.

* If you simply want to calculate the hash of a file on disk with no filters,

* you can just use the `git_odb_hashfile()` API. However, if you want to

* hash a file in the repository and you want to apply filtering rules (e.g.

* crlf filters) before generating the SHA, then use this function.

* Note: if the repository has `core.safecrlf` set to fail and the

* filtering triggers that failure, then this function will return an

* error and not calculate the hash of the file.

* @param out Output value of calculated SHA

* @param repo Repository pointer

* @param path Path to file on disk whose contents should be hashed. This

* may be an absolute path or a relative path, in which case it

* will be treated as a path within the working directory.

* @param type The object type to hash as (e.g. GIT_OBJECT_BLOB)

* @param as_path The path to use to look up filtering rules. If this is

* an empty string then no filters will be applied when

* calculating the hash. If this is `NULL` and the `path`

* parameter is a file within the repository's working

* directory, then the `path` will be used.

* @return 0 on success, or an error code

GIT_EXTERN(int) git_repository_hashfile(

git_oid *out,

git_repository *repo,

const char *path,

git_object_t type,

const char *as_path);

/**

* Make the repository HEAD point to the specified reference.

* If the provided reference points to a Tree or a Blob, the HEAD is

* unaltered and -1 is returned.

* If the provided reference points to a branch, the HEAD will point

* to that branch, staying attached, or become attached if it isn't yet.

* If the branch doesn't exist yet, no error will be return. The HEAD

* will then be attached to an unborn branch.

* Otherwise, the HEAD will be detached and will directly point to

* the Commit.

* @param repo Repository pointer

* @param refname Canonical name of the reference the HEAD should point at

* @return 0 on success, or an error code

GIT_EXTERN(int) git_repository_set_head(

git_repository *repo,

const char *refname);

/**

* Make the repository HEAD directly point to the Commit.

* If the provided committish cannot be found in the repository, the HEAD

* is unaltered and GIT_ENOTFOUND is returned.

* If the provided committish cannot be peeled into a commit, the HEAD

* is unaltered and -1 is returned.

* Otherwise, the HEAD will eventually be detached and will directly point to

* the peeled Commit.

* @param repo Repository pointer

* @param committish Object id of the Commit the HEAD should point to

* @return 0 on success, or an error code

GIT_EXTERN(int) git_repository_set_head_detached(

git_repository *repo,

const git_oid *committish);

/**

* Make the repository HEAD directly point to the Commit.

* This behaves like `git_repository_set_head_detached()` but takes an

* annotated commit, which lets you specify which extended sha syntax

* string was specified by a user, allowing for more exact reflog

* messages.

* See the documentation for `git_repository_set_head_detached()`.

* @param repo Repository pointer

* @param committish annotated commit to point HEAD to

* @return 0 on success, or an error code

GIT_EXTERN(int) git_repository_set_head_detached_from_annotated(

git_repository *repo,

const git_annotated_commit *committish);

/**

* Detach the HEAD.

* If the HEAD is already detached and points to a Commit, 0 is returned.

* If the HEAD is already detached and points to a Tag, the HEAD is

* updated into making it point to the peeled Commit, and 0 is returned.

* If the HEAD is already detached and points to a non committish, the HEAD is

* unaltered, and -1 is returned.

* Otherwise, the HEAD will be detached and point to the peeled Commit.

* @param repo Repository pointer

* @return 0 on success, GIT_EUNBORNBRANCH when HEAD points to a non existing

* branch or an error code

GIT_EXTERN(int) git_repository_detach_head(

git_repository *repo);

/**

* Repository state

* These values represent possible states for the repository to be in,

* based on the current operation which is ongoing.

typedef enum {

GIT_REPOSITORY_STATE_NONE,

GIT_REPOSITORY_STATE_MERGE,

GIT_REPOSITORY_STATE_REVERT,

GIT_REPOSITORY_STATE_REVERT_SEQUENCE,

GIT_REPOSITORY_STATE_CHERRYPICK,

GIT_REPOSITORY_STATE_CHERRYPICK_SEQUENCE,

GIT_REPOSITORY_STATE_BISECT,

GIT_REPOSITORY_STATE_REBASE,

GIT_REPOSITORY_STATE_REBASE_INTERACTIVE,

GIT_REPOSITORY_STATE_REBASE_MERGE,

GIT_REPOSITORY_STATE_APPLY_MAILBOX,

GIT_REPOSITORY_STATE_APPLY_MAILBOX_OR_REBASE

} git_repository_state_t;

/**

* Determines the status of a git repository - ie, whether an operation

* (merge, cherry-pick, etc) is in progress.

* @param repo Repository pointer

* @return The state of the repository

GIT_EXTERN(int) git_repository_state(git_repository *repo);

/**

* Sets the active namespace for this Git Repository

* This namespace affects all reference operations for the repo.

* See `man gitnamespaces`

* @param repo The repo

* @param nmspace The namespace. This should not include the refs

* folder, e.g. to namespace all references under `refs/namespaces/foo/`,

* use `foo` as the namespace.

* @return 0 on success, -1 on error

GIT_EXTERN(int) git_repository_set_namespace(git_repository *repo, const char *nmspace);

/**

* Get the currently active namespace for this repository

* @param repo The repo

* @return the active namespace, or NULL if there isn't one

GIT_EXTERN(const char *) git_repository_get_namespace(git_repository *repo);

/**

* Determine if the repository was a shallow clone

* @param repo The repository

* @return 1 if shallow, zero if not

GIT_EXTERN(int) git_repository_is_shallow(git_repository *repo);

/**

* Retrieve the configured identity to use for reflogs

* The memory is owned by the repository and must not be freed by the

* user.

* @param[out] name where to store the pointer to the name

* @param[out] email where to store the pointer to the email

* @param repo the repository

* @return 0 or an error code

GIT_EXTERN(int) git_repository_ident(const char **name, const char **email, const git_repository *repo);

/**

* Set the identity to be used for writing reflogs

* If both are set, this name and email will be used to write to the

* reflog. Pass NULL to unset. When unset, the identity will be taken

* from the repository's configuration.

* @param repo the repository to configure

View remainder of file in raw view

libgit2/include/git2/repository.h at main · libgit2/libgit2 · GitHub

Repository navigation

Expand file tree

Breadcrumbs

repository.h

Latest commit

History

Breadcrumbs

repository.h

File metadata and controls