Skip to content

Commit

Permalink
Import style guide
Browse files Browse the repository at this point in the history
Commit history was grafted with the following steps:

- in `style-guides` repo
  ```
  git log --pretty=email --patch-with-stat --reverse --full-index --binary -m --first-parent -- ./cpp > style-guide.patch
  ```

- in core repo:
  ```
  git am --ignore-whitespace --committer-date-is-author-date -p2 --directory=doc/dev/style < ~/work/git/style-guides/style-guide.patch
  ```

  This command strips the 'cpp' prefix and applies the patch into
  'doc/dev/style'.

---
TYPE: NO_HISTORY
  • Loading branch information
ihnorton committed Aug 24, 2022
1 parent 67865d5 commit 52111fb
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 9 deletions.
4 changes: 4 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,7 @@ website:
- href: "format_spec/consolidated_fragment_metadata_file.md"
- href: "format_spec/filter_pipeline.md"
- href: "format_spec/vacuum_file.md"

- section: 'Developer Docs'
contents:
- "doc/dev/style/index.md"
15 changes: 8 additions & 7 deletions doc/dev/style/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: C++ Style Guide
title: Style Guide
---

When in doubt and not in conflict with this style guide, follow [C++ Core
Expand All @@ -11,12 +11,13 @@ Where possible we should use up to C++17. Some external packages, such as PDAL a
limited in what they can use. Where we control the environment we should strive
for C++17 usage.

## Functions
### Table of Contents

* See [Functions.md](Functions.md)
* [Inputs on the right. Outputs on the left.](Functions.md#inputs-on-the-right-outputs-on-the-left)
* [Functions](Functions.md)
* With emphasis: [Inputs on the right. Outputs on the left.](Functions.md#inputs-on-the-right-outputs-on-the-left)
* [Memory handling](Memory.md)
* [Storage serialization](Serialization.md)

## Memory Handling

* See [Memory.md](Memory.md)
## CMake

* [CMake guide](CMake.md)
4 changes: 2 additions & 2 deletions format_spec/FORMAT_SPEC.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: Format Specification
---

**Notes:**
**Notes:**

* The current TileDB format version number is **16** (`uint32_t`).
* All data written by TileDB and referenced in this document is **little-endian**.
* All data written by TileDB and referenced in this document is **little-endian**.

## Table of Contents

Expand Down

0 comments on commit 52111fb

Please sign in to comment.