Files

Nadav Har'El 5625624533 doc/dev: add document about analyzing build time

Add a document describing in detail how to use clang's "-ftime-trace"
option, and the ClangBuildAnalyzer tool, to find the source files,
header files and templates which slow down Scylla's build the most.

I've used this tool in the past to reduce Scylla build time - see
commits:

   fa7a302130 (reduced 6.5%)
   f84094320d (reduced 0.1%)
   6ebf32f4d7 (reduced 1%)
   d01e1a774b (reduced 4%)

I'm hoping that documenting how to use this tool will allow other
developers to suggest similar commits.

Refs #1.

Signed-off-by: Nadav Har'El <nyh@scylladb.com>

Closes #15209

2023-09-01 11:33:36 +03:00

api_v2.md

docs: dev: correct a typo

2023-03-31 17:19:08 +03:00

backport.md

dev/docs: add additional git pull to backport docs

2022-11-30 16:14:02 +01:00

building.md

Merge 'Fixes for docs/dev/building.md' from Kamil Braun

2023-02-26 19:27:33 +02:00

cdc.md

docs: cdc: describe generation changes using group 0 topology coordinator

2023-04-20 16:36:41 +02:00

commitlog-file-format.md

docs: Add initial doc on commitlog segment file format

2023-05-15 16:22:44 +03:00

compaction_controller.md

docs: dev: write mathematical expressions in LaTeX

2023-03-29 15:07:14 +03:00

compilation-time-analysis.md

doc/dev: add document about analyzing build time

2023-09-01 11:33:36 +03:00

cql3-type-mapping.md

…

cql-extensions-internal.md

…

debugging.md

docs/dev/debugging.md: recommend open-coredump.sh for opening coredumps

2023-01-12 19:30:59 +02:00

docker-hub.md

Update docker-hub.md

2023-05-24 07:34:58 +03:00

hinted_handoff_design.md

…

IDL.md

idl-compiler: add include statements

2022-08-08 08:02:27 +03:00

isolation.md

Move dev docs to docs/dev

2022-06-24 18:07:08 +01:00

logging.md

Move dev docs to docs/dev

2022-06-24 18:07:08 +01:00

lua-type-mapping.md

…

maintainer.md

scripts: introduce script to apply email, working around google groups brokeness

2022-08-31 14:47:24 +03:00

metrics.md

…

migrating-from-users-to-roles.md

…

mvcc.md

doc: Introduce docs/dev/mvcc.md

2023-01-27 19:15:39 +01:00

object_storage.md

doc: Add a document describing how to configure S3 backend

2023-05-03 20:23:38 +03:00

paged-queries.md

…

parallel_aggregations.md

Move dev docs to docs/dev

2022-06-24 18:07:08 +01:00

per-partition-rate-limit.md

…

protocol-extensions.md

doc: fix the option name LWT_OPTIMIZATION_META_BIT_MASK

2023-02-26 19:51:20 +02:00

protocols.md

Update docs/dev/protocols.md

2022-06-30 19:11:09 +01:00

raft-in-scylla.md

db: system_keyspace: rename 'raft_config' to 'raft_snapshot_config'

2023-01-12 16:21:26 +01:00

reader-concurrency-semaphore.md

docs/dev/reader-concurrency-semaphore.md: add section about operations

2023-06-07 14:22:52 +03:00

README.md

Update docs/dev/README.md

2022-06-30 19:10:41 +01:00

redis.md

Move dev docs to docs/dev

2022-06-24 18:07:08 +01:00

repair_based_node_ops.md

docs/dev/repair_based_node_ops: better formatting

2023-05-25 08:31:43 +03:00

reverse-reads.md

mutation{,_consumer,_partition}: remove consume_in_reverse::legacy_half_reverse

2023-01-05 18:48:55 +01:00

review-checklist.md

…

row_cache.md

doc: Introduce docs/dev/mvcc.md

2023-01-27 19:15:39 +01:00

row_level_repair.md

…

rust.md

rust: use depfile and Cargo.lock to avoid building rust when unnecessary

2023-01-12 14:44:11 +02:00

secondary_index.md

docs/design-notes/secondary_index: add VALUES to index target list

2022-08-14 10:29:52 +03:00

service_levels.md

Move dev docs to docs/dev

2022-06-24 18:07:08 +01:00

sstable-scylla-format.md

sstables: mx/writer: add large_data_type::elements_in_collection

2022-10-04 08:41:56 +03:00

sstables-directory-structure.md

…

system_keyspace.md

tablets: change persistent type of replica set from set to list

2023-08-21 22:55:14 +02:00

system_schema_keyspace.md

Move dev docs to docs/dev

2022-06-24 18:07:08 +01:00

testing.md

docs: dev: document pytest run convenience script

2023-06-07 12:37:52 +03:00

timestamp-conflict-resolution.md

docs: dml: add update ordering section

2023-06-20 11:55:54 +03:00

topology-over-raft.md

raft topology: add the ignore_nodes column to system.topology

2023-08-22 10:30:12 +02:00

tracing.md

Move dev docs to docs/dev

2022-06-24 18:07:08 +01:00

virtual-tables.md

…

README.md

Scylla developer documentation

This folder contains developer-oriented documentation concerning the ScyllaDB codebase. We also have a wiki, which contains additional developer-oriented documentation. There is currently no clear definition of what goes where, so when looking for something be sure to check both.

Seastar documentation can be found here.

User documentation can be found on docs.scylladb.com

For information on how to build Scylla and how to contribute visit HACKING.md and CONTRIBUTING.md.