Commit Graph
263 Commits
Author SHA1 Message Date
Jon Ross-Perkins eac7aecd86 Remove 'no room' idiom (#1852)
Per discussion, this is confusing some people who read it as "don't allow" rather than "no need". I think "no need" is the original intent.
2022-08-01 11:23:10 -07:00
Jon Ross-Perkins 92748e6b35 Update pre-commit version for underscores in symlinks (#1845) 2022-08-01 11:08:05 -07:00
Matt Armstrong fce3618cc2 Try to make some FAQ questions more inviting (#1848)
Replace the "why we don't want to discuss things" question with three
questions covering substantially the same topic. Try to strike a balance
between inviting participation and feedback while still making it clear
that the evolution process produces "firm" decisions.

Address issue #1833.
2022-07-30 19:03:27 -07:00
MarchMore a3dc3cac74 Documentation: Minor corrections of several md files (#1806) 2022-07-30 11:16:11 -07:00
Vitalii 4872f49ce7 Rework of .devcontainer (#1816) (#1817)
> The only issue that I currently have with this one is that the `clangd` extension is having some hiccups, not being able to find includes like `<gmock/gmock.h>` and `<benchmark/benchmark.h>` and thus showing extra errors. However, this only affects the VSCode extension and bazel seems to work fine.

This might be an issue with the compilation database: you might try ./scripts/create_compdb.py to help.
2022-07-30 10:54:45 -07:00
Vaishnavi JoshiandJon Ross-Perkins a60e78485a fixed broken link in faq section (#1825)
The link now redirects to main readme of the project as expected.

Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
2022-07-30 08:30:45 -07:00
Matt Armstrong 2fa74f1d71 Add a new "How can I contribute?" top level heading to the FAQ (#1827)
This provides a natural place for questions about the specifics of how to
contribute effectively, which, near term, is probably where the FAQ will
grow the most near term. This allows the other headings to remain more
focused on their original questions.

Move two existing questions to the new place without changing their
content: "What are the prerequisites for contributing [...]?"  and "Why
aren't people willing to discuss certain topics [...]?".
2022-07-29 17:21:31 -07:00
1b2047d075 Added the ZLib development package as a Linux requirement to the Main Tools section (#1558)
Fixes #1527

On Debian, the zlib1g-dev package is required to build and should be given as a requirement.

Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
2022-07-28 23:05:30 -07:00
yale 85cb70c0a3 Add DevContainer (#1608)
With DevContainer, developers can join the project without deploy the build env.

Signed-off-by: cyw3 <2927096163@qq.com>
2022-07-28 16:03:48 -07:00
josh11b 64f3284a19 Update links to visible copies of docs (#1786)
I've manually copied some Google docs that were referenced in our design .md files so they may be publicly viewable.
2022-07-27 17:45:05 -07:00
SADIK KUZU 0b75f8590c Update brew install command for gh cli (#1775)
Reference: https://github.com/cli/cli#macos
2022-07-27 11:31:40 -07:00
Dan Sarginson 3de94947c0 Update print example in FAQ (#1772)
The named file does not exist
2022-07-27 11:04:12 -07:00
2430c31ea2 [docs] adds new FAQ entries (#1752)
We've observed the following things cropping up regularly enough to
address as 'frequently asked':

* Why isn't there a Carbon logo?
* Where should I ask questions?
* What are the prerequisites for building Carbon?
* Why aren't people willing to discuss certain topics?

Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
2022-07-26 19:07:40 -07:00
josh11bandJon Ross-Perkins eb2d6cfed3 Update the generic implementation model (#1398)
The previous implementation model involved the caller of a function knowing what impls the function will need. With the addition of blanket impls and specialization to the design, that is in general no longer possible. Instead the caller provides a type which is used as a key to look up the impl, which is expected to occur during monomorphization, though we allow the compiler to employ other strategies when the set of impls is predictable.

Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
2022-07-26 19:04:26 -07:00
Kshitij roodkee 8023296728 Update conditional.md (#1714)
Changed the heading, so that there is uniformity across the docs.
2022-07-26 11:37:24 -07:00
Patryk Gutowski a8de3074d8 Fix typo in svg image #1647 (#1652)
There was an extra ')' when calling function QuickSort, switched files and uploaded google drive image.
2022-07-24 14:55:13 -07:00
ooxi 6224f50b8d Fix spelling of primitive types (#1663)
Primitive types have been renamed in pull request #861 and also the design document.
2022-07-24 13:08:31 -07:00
Anton Roos 6cef4645ac Fix grammar errors (#1648)
Fix grammar errors:
- the following audiences sounds more natural.
- are instead of is.
- "to use" is wordy and superfluous.
2022-07-24 12:37:00 -07:00
Joshua Peterson 39d6c4139f Add a link the the stacked pull request docs (#1657)
The stacked pull request documentation exists now, so remove the TODO
and add a link to it.
2022-07-24 10:43:27 -07:00
CharlieS1103andJon Ross-Perkins 68740764f3 Sentence structure and Grammar in Evolution.md (#1543)
Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
2022-07-23 18:03:12 -07:00
Joshua Peterson 9287c825eb Add debugging troubleshooting for GDB (#1613)
Older versions of GDB (before version 10.1) don't work with the
DWARF v5 debugging format the LLVM uses. The error message
which GDB shows when this happens is a bit misleading though.

Provide documentation about how to deal with that error message.
2022-07-23 08:53:03 -07:00
Parisa KhaleghiandJon Ross-Perkins 0bcc6d4ae6 Update contribution_tools.md (#1517)
VS Code is a Code editor, not an IDE!

Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
2022-07-23 08:47:16 -07:00
Josh Soref 066b103881 Spelling (#1580)
This PR corrects misspellings identified by the [check-spelling action](https://github.com/marketplace/actions/check-spelling).

The misspellings have been reported at https://github.com/jsoref/carbon-lang/commit/38a1c1640151899fd6da0442a92557f9543b6280#commitcomment-79197316

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/carbon-lang/commit/173c8f9083a68aa61f7cfe94f720f1e5dc7f1ea3

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2022-07-22 16:14:21 -07:00
Wolfgang E SanyerandChandler Carruth d134990157 Update contribution_tools.md (#1513)
The repository can be forked and cloned using the `gh` cli

Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
2022-07-22 15:04:15 -07:00
Arno Gourdol ce23650db6 Grammar (#1536) 2022-07-22 12:44:08 -04:00
Arno Gourdol 4815a09a79 Grammar (#1535) 2022-07-22 12:43:14 -04:00
Jon Ross-PerkinsandPatryk Gutowski e38c697938 Fix cpp image snippet. (#1567)
There's an extra curly brace per @pacion, and a missing space in print was also reported to us on other forums.

Co-authored-by: Patryk Gutowski <37260994+pacion@users.noreply.github.com>
2022-07-22 09:26:03 -07:00
Jon Ross-Perkins adad33944d Add some build troubleshooting, stop doing version detection. (#1541)
@chandlerc brew is installing clang-14, so I'm not sure the clang-13 is doing much other than risking picking up the wrong version.
2022-07-21 19:40:22 -07:00
josh11b a96ae98155 Fixes to example code in design overview (#1516)
Fix `-` -> `+` in `Distance`. Typo noticed by gingerBill in https://www.youtube.com/watch?v=Z_8lV0nwsc4  .
Also update factory function names `Create` -> `Make`, to reflect latest thinking.
2022-07-21 10:52:38 -04:00
Aleksey Kladov 3f247037ad fix typo (#1505) 2022-07-21 06:12:26 -04:00
mconst 80b7863fdf Fix typo from previous incomplete edit (#1488)
This sentence was replaced in #569, but the words "See the" from the old version didn't get deleted.  Thanks to Kira on Discord for pointing it out!
2022-07-20 21:50:54 -07:00
Jon Ross-Perkins be2f8ed127 Remove convention remark (#1482) 2022-07-20 21:50:05 -07:00
Arno Gourdol d21acc95f9 Spelling, grammar (#1478) 2022-07-20 18:40:16 -04:00
Jon Ross-Perkins 3e0a7db346 Empty tuple doc (#1477) 2022-07-20 13:44:41 -07:00
Ilja van Sprundel e85282567a fix typo in QuickSort code (#1466)
Seems there were 1 too many closing round brackets when calling QuickSort.
2022-07-20 18:25:06 +03:00
Thomas Lively c65284b1a0 Fix memory safety link in faq.md (#1434) 2022-07-19 15:07:18 -07:00
Jon Ross-Perkins 59f91aa0d5 Replace README folders with proper public version (#1430) 2022-07-19 14:50:35 -07:00
Ryan Russell aa4ce80907 docs(design): improve readability (#1431)
Readability improvements focused on `docs/design/.md`

Signed-off-by: Ryan Russell <git@ryanrussell.org>
2022-07-19 17:45:45 -04:00
Matt Godbolt eeb91cb044 Update FAQ to point at compiler explorer instance. (#1429) 2022-07-19 16:14:11 -04:00
Laurent Le Brun d87d58aa52 Spec: Fix link to the Explorer tool (#1420) 2022-07-19 13:50:47 -04:00
Laurent Le Brun 9a370994b5 FAQ: Update link to the Discord server (#1419) 2022-07-19 13:30:01 -04:00
Jon Ross-Perkins 31c3953a5f Orient README around Print (#1409) 2022-07-19 06:17:46 -04:00
c867b38334 Create a FAQ for Carbon (#1385)
Trying to collect together answers for various project questions we've received in previews.

@gribozavr @danakj and @hlopko contributed most of the Rust FAQ entry.

Co-authored-by: Dmitri Gribenko <dmitrig@google.com>
Co-authored-by: Dana Jansens <danakj@google.com>
Co-authored-by: Marcel Hlopko <hlopko@google.com>
Co-authored-by: josh11b <josh11b@users.noreply.github.com>
Co-authored-by: Geoff Romer <gromer@google.com>
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
2022-07-18 11:08:17 -04:00
8dd878b314 Remove CODEOWNERS (#1367)
Remove CODEOWNERS and rely on repository commit access

Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
Co-authored-by: Richard Smith <richard@metafoo.co.uk>
Co-authored-by: Geoff Romer <gromer@google.com>
2022-07-15 15:31:56 -07:00
53053e5959 Design overview update part 7: values (#1378)
This follows #1274 , #1325 , #1328 , #1336 , #1347 , and #1368 . This fills in details about how values work, value categories, parameter passing, unformed state, and so on.

Co-authored-by: Geoff Romer <gromer@google.com>
Co-authored-by: Richard Smith <richard@metafoo.co.uk>
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
2022-07-15 14:42:39 -07:00
josh11b 9863cb98bb Make C++ import syntax match what we've been using in examples (#1397) 2022-07-15 13:47:37 -07:00
josh11b eed666f0d4 Fix interface extends syntax (#1383) 2022-07-12 10:14:32 -07:00
josh11b 16f9d82541 Fix binding syntax to be id: Type (#1381) 2022-07-12 10:14:11 -07:00
josh11bandJon Ross-Perkins 77df7c56d9 Design overview update part 6 (#1368)
This follows #1274 , #1325 , #1328 , #1336 , and #1347 . This has miscellaneous changes to the design overview without a particular focus.

Also adds some missing keywords to our list of keywords.

Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
2022-07-07 22:05:41 -07:00
5535f5ee30 Design overview update part 5: Names (#1347)
This follows #1274 , #1325 , #1328 , and #1336 . It fills in the "Names" section.

Co-authored-by: Richard Smith <richard@metafoo.co.uk>
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
2022-07-06 16:57:25 -07:00