From 4260c78fc25bd084a8fcac72e09ab9a3950be2b6 Mon Sep 17 00:00:00 2001 From: Tom Manshreck Date: Wed, 6 Sep 2017 15:45:43 -0400 Subject: [PATCH] Fix Community Templates, Post Temporary Content --- _includes/c-lang-list.html | 3 +- _includes/contribute-links.html | 2 +- _includes/footer.html | 5 +- _includes/lang-list.html | 3 +- _includes/nav.html | 2 +- _includes/side-nav-community.html | 2 +- _includes/side-nav-cpp.html | 1 - _layouts/community.html | 2 +- _layouts/docs.html | 2 - _sass/modules/_buttons.scss~ | 127 -------- _sass/modules/_footer.scss~ | 207 ------------ _sass/modules/_hero.scss~ | 42 --- _sass/pages/_about.scss | 11 - community/contribute.md | 10 +- css/style.scss | 2 - docs/cpp/resources/compilers.md~ | 515 ------------------------------ docs/cpp/resources/platforms.md~ | 15 - 17 files changed, 12 insertions(+), 939 deletions(-) delete mode 100644 _sass/modules/_buttons.scss~ delete mode 100644 _sass/modules/_footer.scss~ delete mode 100644 _sass/modules/_hero.scss~ delete mode 100644 docs/cpp/resources/compilers.md~ delete mode 100644 docs/cpp/resources/platforms.md~ diff --git a/_includes/c-lang-list.html b/_includes/c-lang-list.html index 20cbfd94..3c628fe0 100644 --- a/_includes/c-lang-list.html +++ b/_includes/c-lang-list.html @@ -1,3 +1,2 @@ Abseil, -C++, -Python, +C++ diff --git a/_includes/contribute-links.html b/_includes/contribute-links.html index 6fac4b99..93027447 100644 --- a/_includes/contribute-links.html +++ b/_includes/contribute-links.html @@ -1,7 +1,7 @@ {% assign file_name = page.path | downcase | split: '/' | last %}
- Contribution Guidelines + Contribution Guidelines

Edit {{file_name}}
\ No newline at end of file diff --git a/_includes/footer.html b/_includes/footer.html index 8d482671..9c9174c1 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -2,7 +2,7 @@
-

©2017 Abseil | Battle-tested, Mom-approved

+

©2017 Abseil | Live at Head

@@ -19,7 +19,6 @@ @@ -27,7 +26,7 @@
    -

    Community

     +

    Community

  • Github

  • Stack Overflow

    • diff --git a/_includes/lang-list.html b/_includes/lang-list.html index 0400306d..6751c1ae 100644 --- a/_includes/lang-list.html +++ b/_includes/lang-list.html @@ -1,3 +1,2 @@ Abseil, -C++, -Python \ No newline at end of file +C++ \ No newline at end of file diff --git a/_includes/nav.html b/_includes/nav.html index 9a92109e..1c67a7a9 100644 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -42,7 +42,7 @@

  • Blog

    • -

  • Community

    • +

  • Community

diff --git a/_includes/side-nav-community.html b/_includes/side-nav-community.html index 9d8feb00..168e9fac 100644 --- a/_includes/side-nav-community.html +++ b/_includes/side-nav-community.html @@ -5,6 +5,6 @@ Contribution Guidelines
  • - + Code of Conduct
    • diff --git a/_includes/side-nav-cpp.html b/_includes/side-nav-cpp.html index a47bfa52..e7fc07e7 100644 --- a/_includes/side-nav-cpp.html +++ b/_includes/side-nav-cpp.html @@ -36,5 +36,4 @@
  • Release Notes
    • -
  • Python Devguide
    • \ No newline at end of file diff --git a/_layouts/community.html b/_layouts/community.html index 8a89fb5b..6b9531a7 100644 --- a/_layouts/community.html +++ b/_layouts/community.html @@ -3,7 +3,7 @@ --- {% assign current = page.url | downcase | split: '/' %} -{% if current[1] == 'about' and page.sidenav != null %} +{% if current[1] == 'community' and page.sidenav != null %}
    diff --git a/_layouts/docs.html b/_layouts/docs.html index d6b1d24b..e09488f4 100644 --- a/_layouts/docs.html +++ b/_layouts/docs.html @@ -35,5 +35,3 @@ {{ content }} {% endif %} {% endif %} - - diff --git a/_sass/modules/_buttons.scss~ b/_sass/modules/_buttons.scss~ deleted file mode 100644 index b92023a2..00000000 --- a/_sass/modules/_buttons.scss~ +++ /dev/null @@ -1,127 +0,0 @@ -.btn, .btn-flat { - - &:focus { - outline: 0 !important; - } - - // GRPC Specific Buttons - &.btn-grpc { - background-color: $secondBrandColor; - color: $white; - font-weight: 300; - letter-spacing: 1px; - - a { - color: $white; - } - - // Inverse Colored Button - &.inverse { - background-color: transparent; - border: 2px solid $mainBrandColor; - border-radius: 4px; - color: $mainBrandColor; - } - - &.btn-doc-call, &.btn-hero { - padding: 4px 27px; - } - - // Landing Page Language Select Button - &.lang-select { - font-size: 14px; - font-weight: 500; - margin: 3px; - padding-left: 6px; - padding-right: 6px; - text-align: center; - text-transform: none; - width: 33%; - - @media (min-width: $tablet) { - max-width: 160px; - margin: 10px; - } - } - - // Hero Button - &.btn-hero { - background-color: $white; - border: 2px solid $secondBrandColor; - border-radius: 4px; - color: $secondBrandColor; - font-weight: 500; - font-size: 14px; - } - } - - // Floating Action Button - &.btn-floating { - background-color: $white; - height: 30px; - width: 30px; - z-index: $z-top; - - @media (min-width: $tablet) { - height: 50px; - width: 50px; - } - - &:hover, - &:focus { - background-color: $white; - } - - &.down-caret { - bottom: -15px; - left: 50%; - padding: 0; - position: absolute; - transform: translateX(-50%); - - @media (min-width: $tablet) { - bottom: -25px; - } - } - } -} - -.fork-btn { - position: absolute; - display: block; - top: -39px; - right: -15px; - width: 150px; - overflow: hidden; - height: 200px; - z-index: 9011; - background: url('../img/github-ribbon.svg') no-repeat center/contain; - - @media (max-width: 830px) { - display: none; - } -} - -// Link Button -.btn-link { - display: inline-block; - cursor: pointer; -} - -.icon-caret { - background: url('../img/caret.svg') no-repeat center/cover; - height: 20px; - margin: 3px auto 0; - width: 24px; - - @media (min-width: $tablet) { - height: 45px; - width: 45px; - } -} - -.external-link-icon { - background: url('../img/external-link.svg') no-repeat center/cover; - width: 15px; - height: 15px; -} diff --git a/_sass/modules/_footer.scss~ b/_sass/modules/_footer.scss~ deleted file mode 100644 index 48f33f7b..00000000 --- a/_sass/modules/_footer.scss~ +++ /dev/null @@ -1,207 +0,0 @@ -// Footer -footer { - background-color: $footerColor; - box-shadow: 0px 500px 0px 500px $footerColor; - color: $white; - overflow: hidden; - padding: 35px 0 0px; - position: relative; - - @media (max-width: 767px) { - padding: 35px 0 120px; - - ul { - li { - display: none; - } - - &.active li { - display: initial; - } - } - } - - a { - color: $white; - - &:hover { - text-decoration: underline; - color: $white; - } - - &::after { - display: none; - } - } - - a.external:after { - display: none; - } - - .active { - display: initial; - } - - .footer-logo { - width: 75px; - margin-left: -8px; - padding: 0 0 10px 0; - - @media (min-width: 768px) { - padding: 0 0 20px 0; - } - } - - .left-links { - color: $footerText; - display: block; - position: absolute; - bottom: 0; - margin: 60px 15px; - text-align: left; - width: 100%; - - p { - font-weight: 200; - font-size: .8em; - } - - @media (min-width: 768px) { - position: relative; - margin: 0 auto; - text-align: left; - display: inline-block; - width: 39%; - } - - @media (min-width: 1025px) { - width: 45%; - margin-left: 5%; - } - - .description { - @media (min-width: 768px) { - padding-top: 9px; - } - } - - } - - .right-links { - width: 100%; - display: table; - margin: 0 0 60px 0; - - & > div { - padding-bottom: 10px; - } - - @media (min-width: 768px) { - padding: 0 0 0 35px; - margin: 0 0 50px 0; - } - - p { - font-weight: 200; - font-size: .8em; - padding: 6px 0; - letter-spacing: .5px; - line-height: 36px; - } - - .right-link-headers { - font-weight: 400; - font-size: 1em; - letter-spacing: .5px; - cursor: pointer; - padding: 15px 0; - position: relative; - - &:after { - content: ''; - background: url('../img/caret.svg') no-repeat center/cover; - background-size: contain; - height: 45px; - width: 35px; - position: absolute; - right: 0; - top: 5px; - cursor: pointer; - } - } - - @media (min-width: $tablet) { - padding: 0; - display: inline-block; - width: 58%; - vertical-align: top; - - .right-link-headers { - padding: 13px 0 14px; - line-height: 1em; - - &:after { - content: none; - } - } - } - - @media (min-width: 1025px) { - width: 49.5%; - } - } - - .footer-sections { - display: block; - width: 120%; - margin: 10px -15px; - background-color: rgba(234,234,234,0.1); - color: rgba(234,234,234,0.1); - border: none; - height: 1px; - - @media (min-width: 768px) { - display: none; - } - } - - .footer-community p { - padding: 7px 0; - - @media(min-width: 990px) { - padding: 6px 0; - } - } - - @mixin social-icon($image-url) { - &::before { - content: ''; - display: inline-block; - background: url($image-url) no-repeat center/cover; - width: 35px; - height: 35px; - vertical-align: middle; - margin: 0 15px 0 0; - } - } - - .github { - @include social-icon('../img/icon_github.svg'); - } - - .google { - @include social-icon('../img/icon_google-plus.svg'); - } - - .twitter { - @include social-icon('../img/icon_twitter.svg'); - } - - .stack-overflow { - @include social-icon('../img/icon_stack-overflow.svg'); - } - - .youtube { - @include social-icon('../img/icon_youtube.svg'); - } -} diff --git a/_sass/modules/_hero.scss~ b/_sass/modules/_hero.scss~ deleted file mode 100644 index 8331cf5d..00000000 --- a/_sass/modules/_hero.scss~ +++ /dev/null @@ -1,42 +0,0 @@ -// Background for nav and hero -.nav-hero-container { - background: url('../img/hero-bg.png') no-repeat center/cover; - z-index: 9010; - position: relative; -} - -// Landing page hero -.hero { - padding-bottom: 60px; - position: relative; - text-align: center; - - @media (min-width: $tablet) { - padding-bottom: 75px; - } - - .hero-title { - color: $black; - display: block; - font-size: 48px; - margin-top: 0; - margin-bottom: $spacing--l; - font-weight: bold; - } - .logo { - border-radius: 1px; - margin-bottom: $spacing--l; - margin-top: $spacing--l; - padding: $spacing--s $spacing--m; - width: 195px; - } - - .hero-lead { - color: $black; - display: block; - font-size: 18px; - margin-top: 0; - margin-bottom: $spacing--l; - font-weight: bold; - } -} diff --git a/_sass/pages/_about.scss b/_sass/pages/_about.scss index f8a9f098..50cd8bde 100644 --- a/_sass/pages/_about.scss +++ b/_sass/pages/_about.scss @@ -152,17 +152,6 @@ } } - .pt-video { - background: url('../img/pt-video-placeholder.png') no-repeat center/cover; - height: auto; - max-width: 100%; - width: auto; - - @media (min-width: $tablet) { - width: 100%; - } - } - .pt-desc { font-size: .85em; font-weight: 300; diff --git a/community/contribute.md b/community/contribute.md index 00a2a3ba..ba06f42c 100644 --- a/community/contribute.md +++ b/community/contribute.md @@ -25,9 +25,9 @@ and in `src/YOUR-LANGUAGE` (e.g. `src/csharp`) ## Guidelines for Pull Requests * Create **small PRs** that are narrowly focused on **addressing a single concern**. - We often time receive PRs that are trying to fix several things at a time, but only one fix is - considered acceptable, nothing gets merged and both author's & review's time is wasted. Create - more PRs to address different concerns and everyone will be happy. + We often time receive PRs that are trying to fix several things at a time, but only + one fix is considered acceptable, nothing gets merged and both author's & review's + time is wasted. Create more PRs to address different concerns and everyone will be happy. * For speculative changes, consider opening an issue and discussing it first. If you are suggesting a behavioral or API change, consider starting with an [Abseil @@ -47,6 +47,4 @@ and in `src/YOUR-LANGUAGE` (e.g. `src/csharp`) * **All tests need to be passing** before your change can be merged. We recommend you **run tests locally** before creating your PR to catch breakages early on (see [tools/run_tests](tools/run_tests). Ultimately, the green signal will be provided by our testing infrastructure. The reviewer will help you if there are test failures that seem not related to the change you are making. -- Exceptions to the rules can be made if there's a compelling reason for doing so. - - +* Exceptions to the rules can be made if there's a compelling reason for doing so. \ No newline at end of file diff --git a/css/style.scss b/css/style.scss index bce334d1..34a3b43a 100644 --- a/css/style.scss +++ b/css/style.scss @@ -23,9 +23,7 @@ @import "pages/_blog"; @import "pages/_docs"; -@import "pages/_faq"; @import "pages/_landing"; @import "pages/_about"; @import "pages/_community"; -@import "pages/_contribute"; @import "materialize/materialize.scss"; diff --git a/docs/cpp/resources/compilers.md~ b/docs/cpp/resources/compilers.md~ deleted file mode 100644 index fb09e13e..00000000 --- a/docs/cpp/resources/compilers.md~ +++ /dev/null @@ -1,515 +0,0 @@ ---- -title: Compiler Macros Guide -layout: docs -sidenav: side-nav-cpp.html -type: markdown ---- - -In low-level libraries like Abseil, macros are used to conditionally compile code for various purposes -like portability, performance, functionality, etc. Here are the categories of macros that are used to -write those preprocessor conditionals: - - * Pre-defined compiler macros - * Build configuration macros - * Feature check macros - -## Pre-defined Compiler Macros - -C and C++ compilers automatically define some macros that can be used to: - - * Identify platforms (architecture, endianness, OS, compiler, C++ standard, library) - * Detect compiler configurations (debug mode, exception handling, etc.) - -## Canonical Macros - -### Architectures - -References: - -* [Pre-defined Compiler Macros](https://sourceforge.net/p/predef/wiki/Architectures/) -* [How to detect the processor type using compiler predefined macros](http://nadeausoftware.com/articles/2012/02/c_c_tip_how_detect_processor_type_using_compiler_predefined_macros) - -|Foo|Bar|Baz| -|AMD64|`__x86_64__`|Defined by GNU C and Sun Studio| -||`_M_X64`|Defined by Visual Studio| -|ARM|`__arm__`|Defined by GNU C| -||`_M_ARM`|Defined by Visual Studio| -|ARM64|`__aarch64__`|Defined by GNU C| - - - - Intel x86 - - `__i386__` - - Defined by GNU C - - - - - - `_M_IX86` - - Only defined for 32-bits architectures -

    -Defined by Visual Studio, Intel C/C++, Digital Mars, and Watcom C/C++ - - - - Intel Itanium (IA-64) - - `__ia64__` - - Defined by GNU C - - - - - - `_M_IA64` - - Defined by Visual Studio - - - - PowerPC - - `__ppc__ || __PPC__ || __ppc64__ || __PPC64__` - - Defined by GNU C - - - - - - `_M_PPC` - - Defined by Visual Studio - - - - Myriad2 - - `__myriad2__` - - - - - - MIPS - - `__mips__` - - Defined by GNUC - - - - - - -### Endianness - -References: - -* https://sourceforge.net/p/predef/wiki/Endianness/ - -There is no standard portable pre-defined macros that can be used to determine endianness. - -Instead, Abseil defines `ABSL_IS_LITTLE_ENDIAN` and `ABSL_IS_BIG_ENDIAN` in `"third_party/absl/base/port.h"`. - -Also, as suggested by this -[paper](https://www.google.com/url?q=http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0463r0.html&sa=D&ust=1492041914805000&usg=AFQjCNG6NAKbx2jfEp_QQwpdedq_D2Jk9g), -we should also add a `enum class endian` to `"third_party/absl/meta/type_traits.h"`. - -### OS - -References: - -* https://sourceforge.net/p/predef/wiki/OperatingSystems/ - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Android - `__ANDROID__` -
    MacOS, iOS - `__APPLE__ && __MACH__` -
    Windows - `_WIN32` -
    Linux - `__linux__` -
    Akaros - `__ros__` -
    Fuchsia - `__Fuchsia__` -
    - -### Compilers - -References: - -* https://sourceforge.net/p/predef/wiki/Compilers/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - Identification - Version - Note -
    GCC - `__GNUC__` - `__GNUC__`, `__GNUC_MINOR__`, `__GNUC_PATCHLEVEL__` - `__GNUC__` is also defined by Clang. If you want to check "GCC only", write `defined(__GNUC__) && !defined(__clang__)` -
    Clang - `__clang__` - `__clang_major__`, `__clang_minor__`, `__clang_patchlevel__` - -
    MSVC - `_MSC_VER` - `_MSC_VER`, `_MSC_FULL_VER` - -
    Emscripten - `__EMSCRIPTEN__` - `__EMSCRIPTEN_major__`, `__EMSCRIPTEN_minor__`, `__EMSCRIPTEN_tiny__` - http://kripken.github.io/emscripten-site/docs/compiling/Building-Projects.html#building-projects -
    asm.js - `__asmjs__` - - When targeting asm.js, the preprocessor defines `__asmjs` and `__asmjs__` are present. -
    NVCC - `__NVCC__` - - http://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/#axzz4hSssNIE2 -
    - -### C++ Standard - -Usually you want to check certain C++ language features: - -* Prefer to use C++ feature testing macros if supported by the compiler: - http://en.cppreference.com/w/cpp/experimental/feature_test. - * GCC 5.0+ https://gcc.gnu.org/gcc-5/changes.html - * Clang - * Not supported by MSVC -* Otherwise check compiler version for the feature support: http://en.cppreference.com/w/cpp/compiler_support - - -### Libraries - -Library headers need to be included before checking the macros. For example, `base/config.h` includes -`` for `__GLIBCXX__`, `_LIBCPP_VERSION`. - - - - - - - - - - - - - - - - - - - - - - -
    libstdc++ - `__GLIBCXX__` -
    libc++ - `_LIBCPP_VERSION` -
    MSVC - `_MSC_VER` -
    GNU glibc - `__GLIBC__` -
    Bionic libc - `__BIONIC__` -
    - - -## Build Configuration Macros - -**NOTE: This list is not complete yet.** - -Abseil expose a few macros for configuration of some modules. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - -Macro - - File - - Purpose - -
    - - - - - -`ABSL_STRIP_LOG` - - - - - -`base/logging.h`(logging) - - - Log messages will be compiled away when `ABSL_STRIP_LOG` is non-zero, for - -security reasons or to reduce binary size. - -
    - - -`ABSL_MIN_LOG_LEVEL` - - - - -`base/log_severity.h` - - - -
    - -`SHRINK_WRAP_FRAME_POINTER` - - - - -`base/stacktrace_x86-inl.inc` - - - http://g3doc/devtools/crosstool/g3doc/shrinkwrapping.md - -This macros should be defined when compiled with `-fshrink-wrap-frame-pointer`. - -**This seems to be an internal optimization, need to confirm.** - -
    - -`NO_FRAME_POINTER` - - - - -`base/stacktrace_config.h` - - - This macro should be defined when compiled with `-fomit-frame-pointer`. - -We need this because there is no good way to check whether `-fomit-frame-pointer` is turned on. - -
    - -`ABSL_FORCE_PTS_MODE` - - - - -`base/per-thread-sem.cc` - - - `ABSL_PTS_MODE` is usually chosen based on OS. - -This macro sets `ABSL_PTS_MODE` manually. - -`ABSL_PTS_MODE` branches the implementation for the `Waiter` class. - -
    - `ADDRESS_SANITIZE` - - - This macro should be defined when compiled with `-fsanitize=address`. -
    - -## Feature Check Macros - -At compile time, we sometimes need to conditionally compile our code based on whether a feature -is provided by the underlying platform (architecture, OS, compiler, C++ standard, library) for -various purposes (portability, performance, sanity check, etc.). In such case, you should -define a feature check macro to check whether the feature is available or missing. Introducing -a feature check macro is better than writing a complex conditional directly because it explicitly -states which feature it is checking and makes the code more readable and maintainable. - -### Definition - -In Abseil, feature check macros are named with `ABSL_` prefix and defined like the following: - -```cpp -#ifdef ABSL_HAVE_FEATURE_FOO -#error "ABSL_HAVE_FEATURE_FOO cannot be overridden." -#elif -#define ABSL_HAVE_FEATURE_FOO 1 -#endif -``` -Feature check macros are not allowed to be overriden (`-D`) on the compiler command line. -They should only be derived from pre-defined macros, other feature check macros or build -configuration macros. - -In terms of writing the preprocessor conditional, you can either white-list all the platforms -where the feature is available, or black-list all the platforms where the feature is missing. -They both have their own pros and cons: - - - - - - - - - - - - - - - - - -
    white-listblack-list
    prosIt's conservative and safe, and more likely to build on a new platform.The compilation fails if a new platform doesn’t support the feature.
    consThe list needs to be extended for new platforms and can turn into a very long list.The compilation might succeed but runtime behavior might be unexpected, if the interface exists but implementation sucks.
    - -It is really a case-by-case decision on which approach to use. The guideline is to think about -what is likely to happen when a new platform is added and which approach is easier to maintain -the invariant of your module. Some examples are: - -1. If you are working around a compiler bug or a missing C++ feature in the standard library -implementation, you probably want to black-list the combinations where the feature is missing. -This way, when a new platform is added, you assume it is standard-compliant, and your unit test -will fail if it is not. - -2. If you are relying on a low-level OS feature for better functionality (more logging, better -debugging context), you probably want to white-list the OSes that claim to support this feature. -This way, when a new OS is added, you assume the feature is missing, and your module will -continue to work with the minimum functionality. If desired, the users can decide to opt-in by -extending the white-list. - -### Usage - -Feature check macros are used to conditionally compile your code like the following: - -```cpp -#ifdef ABSL_HAVE_FEATURE_FOO // or #if ABSL_HAVE_FEATURE_FOO -// Handle the case where feature foo is available. -#else -// Handle the case where feature foo is missing. -#endif -``` - -Make sure you `#include` the header where the feature check macro is defined. - -### Feature Check Macros in Third-party OSS - -Abseil has dependency on some third-party OSS libraries like -[Google Test](https://github.com/google/googletest), which also defines some feature check -macros to help writing tests. For example: `GTEST_HAS_DEATH_TEST`. -For these macros, you should just follow the convention of the third-party repo. \ No newline at end of file diff --git a/docs/cpp/resources/platforms.md~ b/docs/cpp/resources/platforms.md~ deleted file mode 100644 index feb5a118..00000000 --- a/docs/cpp/resources/platforms.md~ +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Platforms -layout: about -sidenav: side-nav-cpp.html -type: markdown ---- - -## Abseil Platforms - -Abseil is supported on the following platforms: - -* Foo -* Bar - -If you have a platform you'd wish added to this list, let us know. \ No newline at end of file